compartment definitions

Create Compartment Definition

post
/organizations/{organizationId}/fhir/3/CompartmentDefinition

A compartment definition that defines how resources are accessed on a server.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringCompartmentDefinitionThis is a CompartmentDefinition resource
urlstringAn absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).
namestringA natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the compartment definition.
statusstringdraft|active|retired|unknownThe status of this compartment definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
publisherstringThe name of the individual or organization that published the compartment definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the compartment definition from a consumer's perspective.
purposestringExplaination of why this compartment definition is needed and why it has been designed as it has.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the compartment definition is intended to be used.
codestringPatient|Encounter|RelatedPerson|Practitioner|DeviceWhich compartment this definition describes.
searchbooleanWhether the search syntax is supported,.
resourcearray(CompartmentDefinition_Resource)Information about how a resource is related to the compartment.

Response

Patch Compartment Definition

patch
/organizations/{organizationId}/fhir/3/CompartmentDefinition/{resourceId}

A compartment definition that defines how resources are accessed on a server.

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*stringCompartmentDefinitionThis is a CompartmentDefinition resource
urlstringAn absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).
namestringA natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the compartment definition.
statusstringdraft|active|retired|unknownThe status of this compartment definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
publisherstringThe name of the individual or organization that published the compartment definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the compartment definition from a consumer's perspective.
purposestringExplaination of why this compartment definition is needed and why it has been designed as it has.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the compartment definition is intended to be used.
codestringPatient|Encounter|RelatedPerson|Practitioner|DeviceWhich compartment this definition describes.
searchbooleanWhether the search syntax is supported,.
resourcearray(CompartmentDefinition_Resource)Information about how a resource is related to the compartment.

Response

Read Compartment Definition

get
/organizations/{organizationId}/fhir/3/CompartmentDefinition/{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 Compartment Definition

get
/organizations/{organizationId}/fhir/3/CompartmentDefinition/{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 Compartment Definition

get
/organizations/{organizationId}/fhir/3/CompartmentDefinition/{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 Compartment Definition

delete
/organizations/{organizationId}/fhir/3/CompartmentDefinition/{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 Compartment Definition

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

Request

Headers

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

Query params

_idstring
_languagestring
codestring
datestring
descriptionstring
jurisdictionstring
namestring
publisherstring
resourcestring
statusstring
titlestring
urlstring

Params

organizationId*string|stringid|slug

Response

Search History Compartment Definition

get
/organizations/{organizationId}/fhir/3/CompartmentDefinition/_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 Compartment Definition

post
/organizations/{organizationId}/fhir/3/CompartmentDefinition/_search

A compartment definition that defines how resources are accessed on a server.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
codestring
datestring
descriptionstring
jurisdictionstring
namestring
publisherstring
resourcestring
statusstring
titlestring
urlstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringCompartmentDefinitionThis is a CompartmentDefinition resource
urlstringAn absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).
namestringA natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the compartment definition.
statusstringdraft|active|retired|unknownThe status of this compartment definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
publisherstringThe name of the individual or organization that published the compartment definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the compartment definition from a consumer's perspective.
purposestringExplaination of why this compartment definition is needed and why it has been designed as it has.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the compartment definition is intended to be used.
codestringPatient|Encounter|RelatedPerson|Practitioner|DeviceWhich compartment this definition describes.
searchbooleanWhether the search syntax is supported,.
resourcearray(CompartmentDefinition_Resource)Information about how a resource is related to the compartment.

Response

Update Compartment Definition

put
/organizations/{organizationId}/fhir/3/CompartmentDefinition/{resourceId}

A compartment definition that defines how resources are accessed on a server.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCompartmentDefinitionThis is a CompartmentDefinition resource
urlstringAn absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).
namestringA natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the compartment definition.
statusstringdraft|active|retired|unknownThe status of this compartment definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
publisherstringThe name of the individual or organization that published the compartment definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the compartment definition from a consumer's perspective.
purposestringExplaination of why this compartment definition is needed and why it has been designed as it has.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the compartment definition is intended to be used.
codestringPatient|Encounter|RelatedPerson|Practitioner|DeviceWhich compartment this definition describes.
searchbooleanWhether the search syntax is supported,.
resourcearray(CompartmentDefinition_Resource)Information about how a resource is related to the compartment.

Response