Organization create

post/Organization
Page View

This resource defines a group of individuals or clinicians that form an organization of some kind. An organization record may consist of multiple organizations, like an umbrella healthcare organization with multiple physical locations.

You can review, retrieve, create, or update organization records.

create

Create a new organization record in your connection's system.

Request parameters and payload

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Organization' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
"resourceType": "Organization",
7
"contained": [
8
{
9
"resourceType": "Endpoint",
10
"id": "string",
11
"identifier": [
12
{
13
"extension": [
14
{
15
"url": "string",
16
"valueBoolean": true
17
}
18
],
19
"use": "usual",
20
"system": "string",
21
"value": "string"
22
}
23
],
24
"status": "active",
25
"connectionType": {
26
"system": "string",
27
"code": "string"
28
},
29
"name": "string",
30
"managingOrganization": {
31
"reference": "string"
32
},
33
"payloadType": [
34
{
35
"coding": [
36
{
37
"code": "string",
38
"system": "string"
39
}
40
],
41
"text": "string"
42
}
43
],
44
"payloadMimeType": [
45
"string"
46
],
47
"address": "string"
48
}
49
],
50
"identifier": [
51
{
52
"system": "http://hl7.org/fhir/sid/us-npi",
53
"value": "string"
54
}
55
],
56
"active": true,
57
"type": [
58
{
59
"coding": [
60
{
61
"system": "string",
62
"code": "string"
63
}
64
],
65
"text": "string"
66
}
67
],
68
"name": "string",
69
"alias": [
70
"string"
71
],
72
"telecom": [
73
{
74
"system": "phone",
75
"value": "string"
76
}
77
],
78
"address": [
79
{
80
"line": [
81
"string"
82
],
83
"city": "string",
84
"state": "string",
85
"postalCode": "string",
86
"country": "string"
87
}
88
],
89
"contact": [
90
{
91
"telecom": [
92
{
93
"system": "phone",
94
"value": "string",
95
"use": "home"
96
}
97
]
98
}
99
],
100
"endpoint": [
101
{
102
"id": "string",
103
"extension": [
104
{
105
"id": "string",
106
"url": "string",
107
"valueBase64Binary": "string"
108
}
109
],
110
"reference": "string",
111
"_reference": {
112
"id": "string",
113
"extension": [
114
{
115
"id": "string",
116
"url": "string",
117
"valueBase64Binary": "string"
118
}
119
]
120
},
121
"type": "string",
122
"_type": {
123
"id": "string",
124
"extension": [
125
{
126
"id": "string",
127
"url": "string",
128
"valueBase64Binary": "string"
129
}
130
]
131
},
132
"identifier": {
133
"id": "string",
134
"extension": [
135
{
136
"id": "string",
137
"url": "string",
138
"valueBase64Binary": "string"
139
}
140
],
141
"use": "usual",
142
"_use": {
143
"id": "string",
144
"extension": [
145
{
146
"id": "string",
147
"url": "string",
148
"valueBase64Binary": "string"
149
}
150
]
151
},
152
"type": {
153
"id": "string",
154
"extension": [
155
{
156
"id": "string",
157
"url": "string",
158
"valueBase64Binary": "string"
159
}
160
],
161
"coding": [
162
{
163
"id": "string",
164
"extension": [
165
{
166
"id": "string",
167
"url": "string",
168
"valueBase64Binary": "string"
169
}
170
],
171
"system": "string",
172
"_system": {
173
"id": "string",
174
"extension": [
175
{
176
"id": "string",
177
"url": "string",
178
"valueBase64Binary": "string"
179
}
180
]
181
},
182
"version": "string",
183
"_version": {
184
"id": "string",
185
"extension": [
186
{
187
"id": "string",
188
"url": "string",
189
"valueBase64Binary": "string"
190
}
191
]
192
},
193
"code": "string",
194
"_code": {
195
"id": "string",
196
"extension": [
197
{
198
"id": "string",
199
"url": "string",
200
"valueBase64Binary": "string"
201
}
202
]
203
},
204
"display": "string",
205
"_display": {
206
"id": "string",
207
"extension": [
208
{
209
"id": "string",
210
"url": "string",
211
"valueBase64Binary": "string"
212
}
213
]
214
},
215
"userSelected": true,
216
"_userSelected": {
217
"id": "string",
218
"extension": [
219
{
220
"id": "string",
221
"url": "string",
222
"valueBase64Binary": "string"
223
}
224
]
225
}
226
}
227
],
228
"text": "string",
229
"_text": {
230
"id": "string",
231
"extension": [
232
{
233
"id": "string",
234
"url": "string",
235
"valueBase64Binary": "string"
236
}
237
]
238
}
239
},
240
"system": "string",
241
"_system": {
242
"id": "string",
243
"extension": [
244
{
245
"id": "string",
246
"url": "string",
247
"valueBase64Binary": "string"
248
}
249
]
250
},
251
"value": "string",
252
"_value": {
253
"id": "string",
254
"extension": [
255
{
256
"id": "string",
257
"url": "string",
258
"valueBase64Binary": "string"
259
}
260
]
261
},
262
"period": {
263
"id": "string",
264
"extension": [
265
{
266
"id": "string",
267
"url": "string",
268
"valueBase64Binary": "string"
269
}
270
],
271
"start": "string",
272
"_start": {
273
"id": "string",
274
"extension": [
275
{
276
"id": "string",
277
"url": "string",
278
"valueBase64Binary": "string"
279
}
280
]
281
},
282
"end": "string",
283
"_end": {
284
"id": "string",
285
"extension": [
286
{
287
"id": "string",
288
"url": "string",
289
"valueBase64Binary": "string"
290
}
291
]
292
}
293
}
294
},
295
"display": "string",
296
"_display": {
297
"id": "string",
298
"extension": [
299
{
300
"id": "string",
301
"url": "string",
302
"valueBase64Binary": "string"
303
}
304
]
305
}
306
}
307
]
308
}'

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, HumanName or Reference

        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.

        • 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.

    • 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).

Response fields and example

Example payload generated from schema

1
{
2
"resourceType": "Organization",
3
"contained": [
4
{
5
"resourceType": "Endpoint",
6
"id": "string",
7
"identifier": [
8
{
9
"extension": [
10
{
11
"url": "string",
12
"valueBoolean": true
13
}
14
],
15
"use": "usual",
16
"system": "string",
17
"value": "string"
18
}
19
],
20
"status": "active",
21
"connectionType": {
22
"system": "string",
23
"code": "string"
24
},
25
"name": "string",
26
"managingOrganization": {
27
"reference": "string"
28
},
29
"payloadType": [
30
{
31
"coding": [
32
{
33
"code": "string",
34
"system": "string"
35
}
36
],
37
"text": "string"
38
}
39
],
40
"payloadMimeType": [
41
"string"
42
],
43
"address": "string"
44
}
45
],
46
"identifier": [
47
{
48
"system": "http://hl7.org/fhir/sid/us-npi",
49
"value": "string"
50
}
51
],
52
"active": true,
53
"type": [
54
{
55
"coding": [
56
{
57
"system": "string",
58
"code": "string"
59
}
60
],
61
"text": "string"
62
}
63
],
64
"name": "string",
65
"alias": [
66
"string"
67
],
68
"telecom": [
69
{
70
"system": "phone",
71
"value": "string"
72
}
73
],
74
"address": [
75
{
76
"line": [
77
"string"
78
],
79
"city": "string",
80
"state": "string",
81
"postalCode": "string",
82
"country": "string"
83
}
84
],
85
"contact": [
86
{
87
"telecom": [
88
{
89
"system": "phone",
90
"value": "string",
91
"use": "home"
92
}
93
]
94
}
95
],
96
"endpoint": [
97
{
98
"id": "string",
99
"extension": [
100
{
101
"id": "string",
102
"url": "string",
103
"valueBase64Binary": "string"
104
}
105
],
106
"reference": "string",
107
"_reference": {
108
"id": "string",
109
"extension": [
110
{
111
"id": "string",
112
"url": "string",
113
"valueBase64Binary": "string"
114
}
115
]
116
},
117
"type": "string",
118
"_type": {
119
"id": "string",
120
"extension": [
121
{
122
"id": "string",
123
"url": "string",
124
"valueBase64Binary": "string"
125
}
126
]
127
},
128
"identifier": {
129
"id": "string",
130
"extension": [
131
{
132
"id": "string",
133
"url": "string",
134
"valueBase64Binary": "string"
135
}
136
],
137
"use": "usual",
138
"_use": {
139
"id": "string",
140
"extension": [
141
{
142
"id": "string",
143
"url": "string",
144
"valueBase64Binary": "string"
145
}
146
]
147
},
148
"type": {
149
"id": "string",
150
"extension": [
151
{
152
"id": "string",
153
"url": "string",
154
"valueBase64Binary": "string"
155
}
156
],
157
"coding": [
158
{
159
"id": "string",
160
"extension": [
161
{
162
"id": "string",
163
"url": "string",
164
"valueBase64Binary": "string"
165
}
166
],
167
"system": "string",
168
"_system": {
169
"id": "string",
170
"extension": [
171
{
172
"id": "string",
173
"url": "string",
174
"valueBase64Binary": "string"
175
}
176
]
177
},
178
"version": "string",
179
"_version": {
180
"id": "string",
181
"extension": [
182
{
183
"id": "string",
184
"url": "string",
185
"valueBase64Binary": "string"
186
}
187
]
188
},
189
"code": "string",
190
"_code": {
191
"id": "string",
192
"extension": [
193
{
194
"id": "string",
195
"url": "string",
196
"valueBase64Binary": "string"
197
}
198
]
199
},
200
"display": "string",
201
"_display": {
202
"id": "string",
203
"extension": [
204
{
205
"id": "string",
206
"url": "string",
207
"valueBase64Binary": "string"
208
}
209
]
210
},
211
"userSelected": true,
212
"_userSelected": {
213
"id": "string",
214
"extension": [
215
{
216
"id": "string",
217
"url": "string",
218
"valueBase64Binary": "string"
219
}
220
]
221
}
222
}
223
],
224
"text": "string",
225
"_text": {
226
"id": "string",
227
"extension": [
228
{
229
"id": "string",
230
"url": "string",
231
"valueBase64Binary": "string"
232
}
233
]
234
}
235
},
236
"system": "string",
237
"_system": {
238
"id": "string",
239
"extension": [
240
{
241
"id": "string",
242
"url": "string",
243
"valueBase64Binary": "string"
244
}
245
]
246
},
247
"value": "string",
248
"_value": {
249
"id": "string",
250
"extension": [
251
{
252
"id": "string",
253
"url": "string",
254
"valueBase64Binary": "string"
255
}
256
]
257
},
258
"period": {
259
"id": "string",
260
"extension": [
261
{
262
"id": "string",
263
"url": "string",
264
"valueBase64Binary": "string"
265
}
266
],
267
"start": "string",
268
"_start": {
269
"id": "string",
270
"extension": [
271
{
272
"id": "string",
273
"url": "string",
274
"valueBase64Binary": "string"
275
}
276
]
277
},
278
"end": "string",
279
"_end": {
280
"id": "string",
281
"extension": [
282
{
283
"id": "string",
284
"url": "string",
285
"valueBase64Binary": "string"
286
}
287
]
288
}
289
}
290
},
291
"display": "string",
292
"_display": {
293
"id": "string",
294
"extension": [
295
{
296
"id": "string",
297
"url": "string",
298
"valueBase64Binary": "string"
299
}
300
]
301
}
302
}
303
]
304
}

    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, HumanName or Reference

        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.

        • 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.

    • 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).