Organization create

Request Body Schema

Create new Organization

• resourceType

  required, string

  Identifies the type of the resource

  Value: Organization
• active

  required, boolean

  Whether the organization's record is still in active use.
• name

  required, string

  A name associated with the organization.
• contained

  Array of object

  These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

  • resourceType

    required, string

    Identifies the type of the resource

    Value: Endpoint
  • status

    required, string

    active | suspended | error | off | test.

    Possible Values: active, suspended, error, off, entered-in-error, test
  • connectionType

    required, object

    A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

    • system

      string

      The identification of the code system that defines the meaning of the symbol in the code.

      Value: https://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionType
    • code

      string

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  • payloadType

    required, Array of object

    The payload type describes the acceptable content that can be communicated on the endpoint.

    • coding

      required, Array of object

      A reference to a code defined by a terminology system.

      • code

        required, string

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        Value: any
      • system

        required, string

        The identification of the code system that defines the meaning of the symbol in the code.

        Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type
    • text

      string

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
  • address

    required, string

    The uri that describes the actual end-point to connect to.
  • id

    string

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
  • identifier

    Array of object

    Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

    • extension

      Array of Boolean, String, CodeableConcept, Coding

      and 1 more...

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      One of: BooleanStringCodeableConceptCodingHumanNameReference
      url
      required, string
      Source of the definition for the extension code - a logical name or a URL.
      valueBoolean
      boolean
      A single value for the extension.
    • use

      string

      The purpose of this identifier.

      Possible Values: usual, official, temp, secondary, old (If known)
    • system

      string

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
    • value

      string

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.
  • name

    string

    A friendly name that this endpoint can be referred to with.
  • managingOrganization

    object

    The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

    Must be a resource of type Organization.

    • reference

      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
  • payloadMimeType

    Array of string

    The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
• identifier

  Array of NPI or Other

  Identifier for the organization that is used to identify the organization across multiple disparate systems.

  Any of: NPIOther
  system
  required, string
  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
  Value: http://hl7.org/fhir/sid/us-npi
  value
  string
  The portion of the identifier typically relevant to the user and which is unique within the context of the system.
• type

  Array of object

  The kind(s) of organization that this is.

  • coding

    Array of object

    A reference to a code defined by a terminology system.

    • system

      string

      The identification of the code system that defines the meaning of the symbol in the code.
    • code

      string

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  • text

    string

    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
• alias

  Array of string

  A list of alternate names that the organization is known as, or was known as in the past.
• telecom

  Array of object

  A contact detail for the organization.

  • system

    string

    Telecommunications form for contact point - what communications system is required to make use of the contact.

    Possible Values: phone, fax, email, pager, url, sms, other
  • value

    string

    The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
• address

  Array of object

  An address for the organization.

  • line

    Array of string

    This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
  • city

    string

    The name of the city, town, suburb, village or other community or delivery center.
  • state

    string

    Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
  • postalCode

    string

    A postal code designating a region defined by the postal service.
  • country

    string

    Country - a nation as commonly understood or generally accepted.
• contact

  Array of object

  Contact for the organization for a certain purpose.

  • telecom

    Array of object

    A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

    • system

      string

      Telecommunications form for contact point - what communications system is required to make use of the contact.

      Possible Values: phone, fax, email, pager, url, sms, other
    • value

      string

      The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
    • use

      string

      Identifies the purpose for the contact point.

      Possible Values: home, work, temp, old, mobile
• endpoint

  Array of object

  Technical endpoints providing access to services operated for the organization.

  Must be a resource of type Endpoint.

  • id

    string

    A sequence of Unicode characters
  • extension

    Array of object

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    • id

      string

      A sequence of Unicode characters
    • url

      string

      String of characters used to identify a name or a resource
    • valueBase64Binary

      string

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
  • reference

    string

    A sequence of Unicode characters
  • _reference

    object

    Extensions for reference

    • id

      string

      A sequence of Unicode characters
    • extension

      Array of object

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • id

        string

        A sequence of Unicode characters
      • url

        string

        String of characters used to identify a name or a resource
      • valueBase64Binary

        string

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
  • type

    string

    String of characters used to identify a name or a resource
  • _type

    object

    Extensions for type

    • id

      string

      A sequence of Unicode characters
    • extension

      Array of object

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • id

        string

        A sequence of Unicode characters
      • url

        string

        String of characters used to identify a name or a resource
      • valueBase64Binary

        string

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
  • identifier

    object

    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

    • id

      string

      A sequence of Unicode characters
    • extension

      Array of object

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • id

        string

        A sequence of Unicode characters
      • url

        string

        String of characters used to identify a name or a resource
      • valueBase64Binary

        string

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
    • use

      The purpose of this identifier.

      Possible Values: usual, official, temp, secondary, old
    • _use

      object

      Extensions for use

      • id

        string

        A sequence of Unicode characters
      • extension

        Array of object

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        • id

          string

          A sequence of Unicode characters
        • url

          string

          String of characters used to identify a name or a resource
        • valueBase64Binary

          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
    • type

      object

      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

      • id

        string

        A sequence of Unicode characters
      • extension

        Array of object

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        • id

          string

          A sequence of Unicode characters
        • url

          string

          String of characters used to identify a name or a resource
        • valueBase64Binary

          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
      • coding

        Array of object

        A reference to a code defined by a terminology system.

        • id

          string

          A sequence of Unicode characters
        • extension

          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id

            string

            A sequence of Unicode characters
          • url

            string

            String of characters used to identify a name or a resource
          • valueBase64Binary

            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
        • system

          string

          String of characters used to identify a name or a resource
        • _system

          object

          Extensions for system

          • id

            string

            A sequence of Unicode characters
          • extension

            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id

              string

              A sequence of Unicode characters
            • url

              string

              String of characters used to identify a name or a resource
            • valueBase64Binary

              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
        • version

          string

          A sequence of Unicode characters
        • _version

          object

          Extensions for version

          • id

            string

            A sequence of Unicode characters
          • extension

            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id

              string

              A sequence of Unicode characters
            • url

              string

              String of characters used to identify a name or a resource
            • valueBase64Binary

              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
        • code

          string

          A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
        • _code

          object

          Extensions for code

          • id

            string

            A sequence of Unicode characters
          • extension

            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id

              string

              A sequence of Unicode characters
            • url

              string

              String of characters used to identify a name or a resource
            • valueBase64Binary

              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
        • display

          string

          A sequence of Unicode characters
        • _display

          object

          Extensions for display

          • id

            string

            A sequence of Unicode characters
          • extension

            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id

              string

              A sequence of Unicode characters
            • url

              string

              String of characters used to identify a name or a resource
            • valueBase64Binary

              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
        • userSelected

          boolean

          Value of "true" or "false"
        • _userSelected

          object

          Extensions for userSelected

          • id

            string

            A sequence of Unicode characters
          • extension

            Array of object

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • id

              string

              A sequence of Unicode characters
            • url

              string

              String of characters used to identify a name or a resource
            • valueBase64Binary

              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
      • text

        string

        A sequence of Unicode characters
      • _text

        object

        Extensions for text

        • id

          string

          A sequence of Unicode characters
        • extension

          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id

            string

            A sequence of Unicode characters
          • url

            string

            String of characters used to identify a name or a resource
          • valueBase64Binary

            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
    • system

      string

      String of characters used to identify a name or a resource
    • _system

      object

      Extensions for system

      • id

        string

        A sequence of Unicode characters
      • extension

        Array of object

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        • id

          string

          A sequence of Unicode characters
        • url

          string

          String of characters used to identify a name or a resource
        • valueBase64Binary

          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
    • value

      string

      A sequence of Unicode characters
    • _value

      object

      Extensions for value

      • id

        string

        A sequence of Unicode characters
      • extension

        Array of object

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        • id

          string

          A sequence of Unicode characters
        • url

          string

          String of characters used to identify a name or a resource
        • valueBase64Binary

          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
    • period

      object

      Time period during which identifier is/was valid for use.

      • id

        string

        A sequence of Unicode characters
      • extension

        Array of object

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        • id

          string

          A sequence of Unicode characters
        • url

          string

          String of characters used to identify a name or a resource
        • valueBase64Binary

          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
      • start

        string

        A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
      • _start

        object

        Extensions for start

        • id

          string

          A sequence of Unicode characters
        • extension

          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id

            string

            A sequence of Unicode characters
          • url

            string

            String of characters used to identify a name or a resource
          • valueBase64Binary

            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
      • end

        string

        A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
      • _end

        object

        Extensions for end

        • id

          string

          A sequence of Unicode characters
        • extension

          Array of object

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • id

            string

            A sequence of Unicode characters
          • url

            string

            String of characters used to identify a name or a resource
          • valueBase64Binary

            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
  • display

    string

    A sequence of Unicode characters
  • _display

    object

    Extensions for display

    • id

      string

      A sequence of Unicode characters
    • extension

      Array of object

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • id

        string

        A sequence of Unicode characters
      • url

        string

        String of characters used to identify a name or a resource
      • valueBase64Binary

        string

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).