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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringOrganizationThis is a Organization resource
identifierarray(Identifier)Identifier for the organization that is used to identify the organization across multiple disparate systems.
activebooleanWhether the organization's record is still in active use.
typearray(CodeableConcept)The kind(s) of organization that this is.
namestringA name associated with the organization.
aliasarray()A list of alternate names that the organization is known as, or was known as in the past.
telecomarray(ContactPoint)A contact detail for the organization.
addressarray(Address)An address for the organization.
partOfReferenceThe organization of which this organization forms a part.
contactarray(Organization_Contact)Contact for the organization for a certain purpose.
endpointarray(Reference)Technical endpoints providing access to services operated for the organization.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringOrganizationThis is a Organization resource
identifierarray(Identifier)Identifier for the organization that is used to identify the organization across multiple disparate systems.
activebooleanWhether the organization's record is still in active use.
typearray(CodeableConcept)The kind(s) of organization that this is.
namestringA name associated with the organization.
aliasarray()A list of alternate names that the organization is known as, or was known as in the past.
telecomarray(ContactPoint)A contact detail for the organization.
addressarray(Address)An address for the organization.
partOfReferenceThe organization of which this organization forms a part.
contactarray(Organization_Contact)Contact for the organization for a certain purpose.
endpointarray(Reference)Technical endpoints providing access to services operated for the organization.

Response

Read Organization

get
/organizations/{organizationId}/fhir/3/Organization/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Organization

get
/organizations/{organizationId}/fhir/3/Organization/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Organization

get
/organizations/{organizationId}/fhir/3/Organization/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Organization

delete
/organizations/{organizationId}/fhir/3/Organization/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Organization

get
/organizations/{organizationId}/fhir/3/Organization

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
endpointstring
identifierstring
namestring
partofstring
phoneticstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Organization

get
/organizations/{organizationId}/fhir/3/Organization/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
endpointstring
identifierstring
namestring
partofstring
phoneticstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringOrganizationThis is a Organization resource
identifierarray(Identifier)Identifier for the organization that is used to identify the organization across multiple disparate systems.
activebooleanWhether the organization's record is still in active use.
typearray(CodeableConcept)The kind(s) of organization that this is.
namestringA name associated with the organization.
aliasarray()A list of alternate names that the organization is known as, or was known as in the past.
telecomarray(ContactPoint)A contact detail for the organization.
addressarray(Address)An address for the organization.
partOfReferenceThe organization of which this organization forms a part.
contactarray(Organization_Contact)Contact for the organization for a certain purpose.
endpointarray(Reference)Technical endpoints providing access to services operated for the organization.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringOrganizationThis is a Organization resource
identifierarray(Identifier)Identifier for the organization that is used to identify the organization across multiple disparate systems.
activebooleanWhether the organization's record is still in active use.
typearray(CodeableConcept)The kind(s) of organization that this is.
namestringA name associated with the organization.
aliasarray()A list of alternate names that the organization is known as, or was known as in the past.
telecomarray(ContactPoint)A contact detail for the organization.
addressarray(Address)An address for the organization.
partOfReferenceThe organization of which this organization forms a part.
contactarray(Organization_Contact)Contact for the organization for a certain purpose.
endpointarray(Reference)Technical endpoints providing access to services operated for the organization.

Response