Composition - FHIR Resource (r4)
This Composition Resource uses the FHIR API standard for access and structure.
Validate an Composition FHIR Resource (r4)
Composition Attributes
AttributeField is listTypeDescription
Description: Version-independent identifier for the Composition
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": {
"system": "http://healthintersections.com.au/test",
"value": "1"
}Learn more about the (Composition) identifier FHIR attribute
Description: preliminary | final | amended | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "final"Learn more about the (Composition) status FHIR attribute
Description: Kind of composition (LOINC if possible)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11488-4",
"display": "Consult note"
}
]
}Learn more about the (Composition) type FHIR attribute
Description: Categorization of Composition
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP173421-1",
"display": "Report"
}
]
}
]Learn more about the (Composition) category FHIR attribute
Description: Who and/or what the composition is about
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/xcda",
"display": "Henry Levin the 7th"
}Learn more about the (Composition) subject FHIR attribute
Description: Context of the Composition
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": {
"reference": "Encounter/xcda"
}Learn more about the (Composition) encounter FHIR attribute
Description: Composition editing time
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2012-01-04T09:10:14Z"Learn more about the (Composition) date FHIR attribute
Description: "author" : [{ Reference(Practitioner|PractitionerRole|Device|Patient|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": [
{
"reference": "Practitioner/xcda-author",
"display": "Harold Hippocrates, MD"
}
]Learn more about the (Composition) author FHIR attribute
Description: Human Readable name/title
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": "Consultation Note"Learn more about the (Composition) title FHIR attribute
Description: As defined by affinity domain
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"confidentiality": "N"Learn more about the (Composition) confidentiality FHIR attribute
Description: Attests to accuracy of composition
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"attester": [
{
"mode": "legal",
"time": "2012-01-04T09:10:14Z",
"party": {
"reference": "Practitioner/xcda-author",
"display": "Harold Hippocrates, MD"
}
}
]Learn more about the (Composition) attester FHIR attribute
Description: Organization which maintains the composition
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"custodian": {
"reference": "Organization/2.16.840.1.113883.19.5",
"display": "Good Health Clinic"
}Learn more about the (Composition) custodian FHIR attribute
Description: Relationships to other compositions/documents
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relatesTo": [
{
"code": "replaces",
"targetReference": {
"reference": "Composition/old-example"
}
},
{
"code": "appends",
"targetIdentifier": {
"system": "http://example.org/fhir/NamingSystem/document-ids",
"value": "ABC123"
}
}
]Learn more about the (Composition) relatesTo FHIR attribute
Description: The clinical service(s) being documented
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"event": [
{
"code": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "HEALTHREC",
"display": "health record"
}
]
}
],
"period": {
"start": "2010-07-18",
"end": "2012-11-12"
},
"detail": [
{
"reference": "Observation/example"
}
]
}
]Learn more about the (Composition) event FHIR attribute
Description: Composition is broken into sections
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"section": [
{
"title": "History of present illness",
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "11348-0",
"display": "History of past illness Narrative"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t\t<table>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>Code</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>Date</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>Type</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>BodySite</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>Severity</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Stroke</td>\n\t\t\t\t\t\t<td>2010-07-18</td>\n\t\t\t\t\t\t<td>Diagnosis</td>\n\t\t\t\t\t\t<td/>\n\t\t\t\t\t\t<td/>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Burnt Ear</td>\n\t\t\t\t\t\t<td>2012-05-24</td>\n\t\t\t\t\t\t<td>Diagnosis</td>\n\t\t\t\t\t\t<td>Left Ear</td>\n\t\t\t\t\t\t<td/>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Asthma</td>\n\t\t\t\t\t\t<td>2012-11-12</td>\n\t\t\t\t\t\t<td>Finding</td>\n\t\t\t\t\t\t<td/>\n\t\t\t\t\t\t<td>Mild</td>\n\t\t\t\t\t</tr>\n\t\t\t\t</table>\n\t\t\t</div>"
},
"mode": "snapshot",
"orderedBy": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/list-order",
"code": "event-date",
"display": "Sorted by Event Date"
}
]
},
"entry": [
{
"reference": "Condition/stroke"
},
{
"reference": "Condition/example"
},
{
"reference": "Condition/example2"
}
]
},
{
"title": "History of family member diseases",
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "10157-6",
"display": "History of family member diseases Narrative"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t\t<p>History of family member diseases - not available</p>\n\t\t\t</div>"
},
"mode": "snapshot",
"emptyReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/list-empty-reason",
"code": "withheld",
"display": "Information Withheld"
}
]
}
}
]Learn more about the (Composition) section FHIR attribute
Composition Example
{
"resourceType": "Composition",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>Consultation note for Henry Levin the 7th</p>\n\t\t\t<p>Managed by Good Health Clinic</p>\n\t\t</div>"
},
"identifier": {
"system": "http://healthintersections.com.au/test",
"value": "1"
},
"status": "final",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11488-4",
"display": "Consult note"
}
]
},
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP173421-1",
"display": "Report"
}
]
}
],
"subject": {
"reference": "Patient/xcda",
"display": "Henry Levin the 7th"
},
"encounter": {
"reference": "Encounter/xcda"
},
"date": "2012-01-04T09:10:14Z",
"author": [
{
"reference": "Practitioner/xcda-author",
"display": "Harold Hippocrates, MD"
}
],
"title": "Consultation Note",
"confidentiality": "N",
"attester": [
{
"mode": "legal",
"time": "2012-01-04T09:10:14Z",
"party": {
"reference": "Practitioner/xcda-author",
"display": "Harold Hippocrates, MD"
}
}
],
"custodian": {
"reference": "Organization/2.16.840.1.113883.19.5",
"display": "Good Health Clinic"
},
"relatesTo": [
{
"code": "replaces",
"targetReference": {
"reference": "Composition/old-example"
}
},
{
"code": "appends",
"targetIdentifier": {
"system": "http://example.org/fhir/NamingSystem/document-ids",
"value": "ABC123"
}
}
],
"event": [
{
"code": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "HEALTHREC",
"display": "health record"
}
]
}
],
"period": {
"start": "2010-07-18",
"end": "2012-11-12"
},
"detail": [
{
"reference": "Observation/example"
}
]
}
],
"section": [
{
"title": "History of present illness",
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "11348-0",
"display": "History of past illness Narrative"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t\t<table>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>Code</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>Date</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>Type</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>BodySite</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t\t<td>\n\t\t\t\t\t\t\t<b>Severity</b>\n\t\t\t\t\t\t</td>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Stroke</td>\n\t\t\t\t\t\t<td>2010-07-18</td>\n\t\t\t\t\t\t<td>Diagnosis</td>\n\t\t\t\t\t\t<td/>\n\t\t\t\t\t\t<td/>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Burnt Ear</td>\n\t\t\t\t\t\t<td>2012-05-24</td>\n\t\t\t\t\t\t<td>Diagnosis</td>\n\t\t\t\t\t\t<td>Left Ear</td>\n\t\t\t\t\t\t<td/>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>Asthma</td>\n\t\t\t\t\t\t<td>2012-11-12</td>\n\t\t\t\t\t\t<td>Finding</td>\n\t\t\t\t\t\t<td/>\n\t\t\t\t\t\t<td>Mild</td>\n\t\t\t\t\t</tr>\n\t\t\t\t</table>\n\t\t\t</div>"
},
"mode": "snapshot",
"orderedBy": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/list-order",
"code": "event-date",
"display": "Sorted by Event Date"
}
]
},
"entry": [
{
"reference": "Condition/stroke"
},
{
"reference": "Condition/example"
},
{
"reference": "Condition/example2"
}
]
},
{
"title": "History of family member diseases",
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "10157-6",
"display": "History of family member diseases Narrative"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t\t<p>History of family member diseases - not available</p>\n\t\t\t</div>"
},
"mode": "snapshot",
"emptyReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/list-empty-reason",
"code": "withheld",
"display": "Information Withheld"
}
]
}
}
]
}Composition Structure
{
"resourceType" : "Composition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // Version-independent identifier for the Composition
"status" : "<code>", // R! preliminary | final | amended | entered-in-error
"type" : { CodeableConcept }, // R! Kind of composition (LOINC if possible)
"category" : [{ CodeableConcept }], // Categorization of Composition
"subject" : { Reference(Any) }, // Who and/or what the composition is about
"encounter" : { Reference(Encounter) }, // Context of the Composition
"date" : "<dateTime>", // R! Composition editing time
"author" : [{ Reference(Practitioner|PractitionerRole|Device|Patient|
RelatedPerson|Organization) }], // R! Who and/or what authored the composition
"title" : "<string>", // R! Human Readable name/title
"confidentiality" : "<code>", // As defined by affinity domain
"attester" : [{ // Attests to accuracy of composition
"mode" : "<code>", // R! personal | professional | legal | official
"time" : "<dateTime>", // When the composition was attested
"party" : { Reference(Patient|RelatedPerson|Practitioner|PractitionerRole|
Organization) } // Who attested the composition
}],
"custodian" : { Reference(Organization) }, // Organization which maintains the composition
"relatesTo" : [{ // Relationships to other compositions/documents
"code" : "<code>", // R! replaces | transforms | signs | appends
// target[x]: Target of the relationship. One of these 2:
"targetIdentifier" : { Identifier }
"targetReference" : { Reference(Composition) }
}],
"event" : [{ // The clinical service(s) being documented
"code" : [{ CodeableConcept }], // Code(s) that apply to the event being documented
"period" : { Period }, // The period covered by the documentation
"detail" : [{ Reference(Any) }] // The event(s) being documented
}],
"section" : [{ // Composition is broken into sections
"title" : "<string>", // Label for section (e.g. for ToC)
"code" : { CodeableConcept }, // Classification of section (recommended)
"author" : [{ Reference(Practitioner|PractitionerRole|Device|Patient|
RelatedPerson|Organization) }], // Who and/or what authored the section
"focus" : { Reference(Any) }, // Who/what the section is about, when it is not about the subject of composition
"text" : { Narrative }, // C? Text summary of the section, for human interpretation
"mode" : "<code>", // working | snapshot | changes
"orderedBy" : { CodeableConcept }, // Order of section entries
"entry" : [{ Reference(Any) }], // C? A reference to data that supports this section
"emptyReason" : { CodeableConcept }, // C? Why the section is empty
"section" : [{ Content as for Composition.section }] // C? Nested Section
}]
}
Composition Search Parameters
The following search parameters can be used to query Composition resources. Just submit them like so:
https://api.1up.health/fhir/r4/Composition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
attester | reference | attester.party |
author | reference | author |
category | text | category |
confidentiality | text | confidentiality |
context | text | event.code |
date | date | date |
encounter | reference | encounter |
entry | reference | section.entry |
identifier | text | identifier |
patient | reference | subject.where |
period | date | event.period |
related-id | text | relatesTo.target |
related-ref | reference | relatesTo.target |
section | text | section.code |
status | text | status |
subject | reference | subject |
title | text | title |
type | text | type |
