organizations
Create Organization
post
/organizations/{organizationId}/fhir/3/Organization
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Organization | This is a Organization resource |
| identifier | array(Identifier) | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |
| active | boolean | Whether the organization's record is still in active use. | |
| type | array(CodeableConcept) | The kind(s) of organization that this is. | |
| name | string | A name associated with the organization. | |
| alias | array() | A list of alternate names that the organization is known as, or was known as in the past. | |
| telecom | array(ContactPoint) | A contact detail for the organization. | |
| address | array(Address) | An address for the organization. | |
| partOf | Reference | The organization of which this organization forms a part. | |
| contact | array(Organization_Contact) | Contact for the organization for a certain purpose. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the organization. |
Response
keyboard_arrow_down
Patch Organization
patch
/organizations/{organizationId}/fhir/3/Organization/{resourceId}
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Organization | This is a Organization resource |
| identifier | array(Identifier) | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |
| active | boolean | Whether the organization's record is still in active use. | |
| type | array(CodeableConcept) | The kind(s) of organization that this is. | |
| name | string | A name associated with the organization. | |
| alias | array() | A list of alternate names that the organization is known as, or was known as in the past. | |
| telecom | array(ContactPoint) | A contact detail for the organization. | |
| address | array(Address) | An address for the organization. | |
| partOf | Reference | The organization of which this organization forms a part. | |
| contact | array(Organization_Contact) | Contact for the organization for a certain purpose. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the organization. |
Response
keyboard_arrow_down
Read Organization
get
/organizations/{organizationId}/fhir/3/Organization/{resourceId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Organization
get
/organizations/{organizationId}/fhir/3/Organization/{resourceId}/_history
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Organization
get
/organizations/{organizationId}/fhir/3/Organization/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Organization
delete
/organizations/{organizationId}/fhir/3/Organization/{resourceId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Organization
get
/organizations/{organizationId}/fhir/3/Organization
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| address | string | ||
| address-city | string | ||
| address-country | string | ||
| address-postalcode | string | ||
| address-state | string | ||
| address-use | string | ||
| endpoint | string | ||
| identifier | string | ||
| name | string | ||
| partof | string | ||
| phonetic | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Organization
get
/organizations/{organizationId}/fhir/3/Organization/_history
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Organization
post
/organizations/{organizationId}/fhir/3/Organization/_search
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| address | string | ||
| address-city | string | ||
| address-country | string | ||
| address-postalcode | string | ||
| address-state | string | ||
| address-use | string | ||
| endpoint | string | ||
| identifier | string | ||
| name | string | ||
| partof | string | ||
| phonetic | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Organization | This is a Organization resource |
| identifier | array(Identifier) | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |
| active | boolean | Whether the organization's record is still in active use. | |
| type | array(CodeableConcept) | The kind(s) of organization that this is. | |
| name | string | A name associated with the organization. | |
| alias | array() | A list of alternate names that the organization is known as, or was known as in the past. | |
| telecom | array(ContactPoint) | A contact detail for the organization. | |
| address | array(Address) | An address for the organization. | |
| partOf | Reference | The organization of which this organization forms a part. | |
| contact | array(Organization_Contact) | Contact for the organization for a certain purpose. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the organization. |
Response
keyboard_arrow_down
Update Organization
put
/organizations/{organizationId}/fhir/3/Organization/{resourceId}
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Organization | This is a Organization resource |
| identifier | array(Identifier) | Identifier for the organization that is used to identify the organization across multiple disparate systems. | |
| active | boolean | Whether the organization's record is still in active use. | |
| type | array(CodeableConcept) | The kind(s) of organization that this is. | |
| name | string | A name associated with the organization. | |
| alias | array() | A list of alternate names that the organization is known as, or was known as in the past. | |
| telecom | array(ContactPoint) | A contact detail for the organization. | |
| address | array(Address) | An address for the organization. | |
| partOf | Reference | The organization of which this organization forms a part. | |
| contact | array(Organization_Contact) | Contact for the organization for a certain purpose. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the organization. |
Response
keyboard_arrow_down