compositions

Create Composition

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

A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringCompositionThis is a Composition resource
identifierIdentifierLogical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
statusstringpreliminary|final|amended|entered-in-errorThe workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
type*CodeableConceptSpecifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
classCodeableConceptA categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
subject*ReferenceWho or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
encounterReferenceDescribes the clinical encounter or type of care this documentation is associated with.
datestringThe composition editing time, when the composition was last logically changed by the author.
author*array(Reference)Identifies who is responsible for the information in the composition, not necessarily who typed it in.
titlestringOfficial human-readable label for the composition.
confidentialitystringThe code specifying the level of confidentiality of the Composition.
attesterarray(Composition_Attester)A participant who has attested to the accuracy of the composition/document.
custodianReferenceIdentifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
relatesToarray(Composition_RelatesTo)Relationships that this composition has with other compositions or documents that already exist.
eventarray(Composition_Event)The clinical service, such as a colonoscopy or an appendectomy, being documented.
sectionarray(Composition_Section)The root of the sections that make up the composition.

Response

Patch Composition

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

A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

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*stringCompositionThis is a Composition resource
identifierIdentifierLogical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
statusstringpreliminary|final|amended|entered-in-errorThe workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
type*CodeableConceptSpecifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
classCodeableConceptA categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
subject*ReferenceWho or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
encounterReferenceDescribes the clinical encounter or type of care this documentation is associated with.
datestringThe composition editing time, when the composition was last logically changed by the author.
author*array(Reference)Identifies who is responsible for the information in the composition, not necessarily who typed it in.
titlestringOfficial human-readable label for the composition.
confidentialitystringThe code specifying the level of confidentiality of the Composition.
attesterarray(Composition_Attester)A participant who has attested to the accuracy of the composition/document.
custodianReferenceIdentifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
relatesToarray(Composition_RelatesTo)Relationships that this composition has with other compositions or documents that already exist.
eventarray(Composition_Event)The clinical service, such as a colonoscopy or an appendectomy, being documented.
sectionarray(Composition_Section)The root of the sections that make up the composition.

Response

Read Composition

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
attesterstring
authorstring
classstring
confidentialitystring
contextstring
datestring
encounterstring
entrystring
identifierstring
patientstring
periodstring
related-idstring
related-refstring
sectionstring
statusstring
subjectstring
titlestring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Composition

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

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

A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

Request

Headers

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

Query params

_idstring
_languagestring
attesterstring
authorstring
classstring
confidentialitystring
contextstring
datestring
encounterstring
entrystring
identifierstring
patientstring
periodstring
related-idstring
related-refstring
sectionstring
statusstring
subjectstring
titlestring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringCompositionThis is a Composition resource
identifierIdentifierLogical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
statusstringpreliminary|final|amended|entered-in-errorThe workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
type*CodeableConceptSpecifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
classCodeableConceptA categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
subject*ReferenceWho or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
encounterReferenceDescribes the clinical encounter or type of care this documentation is associated with.
datestringThe composition editing time, when the composition was last logically changed by the author.
author*array(Reference)Identifies who is responsible for the information in the composition, not necessarily who typed it in.
titlestringOfficial human-readable label for the composition.
confidentialitystringThe code specifying the level of confidentiality of the Composition.
attesterarray(Composition_Attester)A participant who has attested to the accuracy of the composition/document.
custodianReferenceIdentifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
relatesToarray(Composition_RelatesTo)Relationships that this composition has with other compositions or documents that already exist.
eventarray(Composition_Event)The clinical service, such as a colonoscopy or an appendectomy, being documented.
sectionarray(Composition_Section)The root of the sections that make up the composition.

Response

Update Composition

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

A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCompositionThis is a Composition resource
identifierIdentifierLogical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
statusstringpreliminary|final|amended|entered-in-errorThe workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
type*CodeableConceptSpecifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
classCodeableConceptA categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
subject*ReferenceWho or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
encounterReferenceDescribes the clinical encounter or type of care this documentation is associated with.
datestringThe composition editing time, when the composition was last logically changed by the author.
author*array(Reference)Identifies who is responsible for the information in the composition, not necessarily who typed it in.
titlestringOfficial human-readable label for the composition.
confidentialitystringThe code specifying the level of confidentiality of the Composition.
attesterarray(Composition_Attester)A participant who has attested to the accuracy of the composition/document.
custodianReferenceIdentifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
relatesToarray(Composition_RelatesTo)Relationships that this composition has with other compositions or documents that already exist.
eventarray(Composition_Event)The clinical service, such as a colonoscopy or an appendectomy, being documented.
sectionarray(Composition_Section)The root of the sections that make up the composition.

Response