compositions

Create Composition

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

A set of healthcare-related information that is assembled together into a single logical package 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. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Composition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)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.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierA version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
statuspreliminary|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.
categoryarray(CodeableConcept)A 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.
subjectReferenceWho 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.
datedateTimeThe 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.
confidentialitycodeThe 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/4/Composition/{resourceId}

A set of healthcare-related information that is assembled together into a single logical package 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. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, 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*This is a Composition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)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.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierA version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
statuspreliminary|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.
categoryarray(CodeableConcept)A 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.
subjectReferenceWho 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.
datedateTimeThe 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.
confidentialitycodeThe 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/4/Composition/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Composition

get
/organizations/{organizationId}/fhir/4/Composition/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Composition/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Composition

delete
/organizations/{organizationId}/fhir/4/Composition/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Composition

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

Request

Headers

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

Query params

_idstring
_languagestring
attesterstring
authorstring
categorystring
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/4/Composition/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Composition/_search

A set of healthcare-related information that is assembled together into a single logical package 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. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, 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
attesterstring
authorstring
categorystring
confidentialitystring
contextstring
datestring
encounterstring
entrystring
identifierstring
patientstring
periodstring
related-idstring
related-refstring
sectionstring
statusstring
subjectstring
titlestring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Composition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)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.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierA version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
statuspreliminary|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.
categoryarray(CodeableConcept)A 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.
subjectReferenceWho 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.
datedateTimeThe 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.
confidentialitycodeThe 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/4/Composition/{resourceId}

A set of healthcare-related information that is assembled together into a single logical package 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. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Composition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)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.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierA version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
statuspreliminary|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.
categoryarray(CodeableConcept)A 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.
subjectReferenceWho 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.
datedateTimeThe 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.
confidentialitycodeThe 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