Composition - FHIR Resource (stu3)

This Composition Resource uses the FHIR API standard for access and structure.

Validate an Composition FHIR Resource (stu3)

Composition Attributes

AttributeField is listTypeDescription

Description: preliminary | final | amended | entered-in-error

FHIR Version: stu3

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: As defined by affinity domain

FHIR Version: stu3

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: Human Readable name/title

FHIR Version: stu3

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: Organization which maintains the composition

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"custodian": {
  "display": "Good Health Clinic",
  "reference": "Organization/2.16.840.1.113883.19.5"
}

Learn more about the (Composition) custodian FHIR attribute

Description: Attests to accuracy of composition

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"attester": [
  {
    "party": {
      "display": "Harold Hippocrates, MD",
      "reference": "Practitioner/xcda-author"
    },
    "mode": [
      "legal"
    ],
    "time": "2012-01-04T09:10:14Z"
  }
]

Learn more about the (Composition) attester FHIR attribute

Description: Who and/or what authored the composition

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"author": [
  {
    "display": "Harold Hippocrates, MD",
    "reference": "Practitioner/xcda-author"
  }
]

Learn more about the (Composition) author FHIR attribute

Description: Relationships to other compositions/documents

FHIR Version: stu3

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: Categorization of Composition

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"class": {
  "coding": [
    {
      "code": "LP173421-1",
      "system": "http://loinc.org",
      "display": "Report"
    }
  ]
}

Learn more about the (Composition) class FHIR attribute

Description: Composition is broken into sections

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"section": [
  {
    "code": {
      "coding": [
        {
          "code": "11348-0",
          "system": "http://loinc.org",
          "display": "History of past illness Narrative"
        }
      ]
    },
    "title": "History of present illness",
    "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>"
    },
    "orderedBy": {
      "coding": [
        {
          "code": "event-date",
          "system": "http://hl7.org/fhir/list-order",
          "display": "Sorted by Event Date"
        }
      ]
    },
    "mode": "snapshot",
    "entry": [
      {
        "reference": "Condition/stroke"
      },
      {
        "reference": "Condition/example"
      },
      {
        "reference": "Condition/example2"
      }
    ]
  },
  {
    "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>"
    },
    "code": {
      "coding": [
        {
          "code": "10157-6",
          "system": "http://loinc.org",
          "display": "History of family member diseases Narrative"
        }
      ]
    },
    "emptyReason": {
      "coding": [
        {
          "code": "withheld",
          "system": "http://hl7.org/fhir/list-empty-reason",
          "display": "Information Withheld"
        }
      ]
    },
    "mode": "snapshot",
    "title": "History of family member diseases"
  }
]

Learn more about the (Composition) section FHIR attribute

Description: Composition editing time

FHIR Version: stu3

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: Logical identifier of composition (version-independent)

FHIR Version: stu3

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: Kind of composition (LOINC if possible)

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": {
  "coding": [
    {
      "code": "11488-4",
      "system": "http://loinc.org",
      "display": "Consult note"
    }
  ]
}

Learn more about the (Composition) type FHIR attribute

Description: The clinical service(s) being documented

FHIR Version: stu3

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": [
          {
            "code": "HEALTHREC",
            "system": "http://hl7.org/fhir/v3/ActCode",
            "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: Context of the Composition

FHIR Version: stu3

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: Who and/or what the composition is about

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subject": {
  "display": "Henry Levin the 7th",
  "reference": "Patient/xcda"
}

Learn more about the (Composition) subject FHIR attribute

Composition Example

{
  "status": "final",
  "confidentiality": "N",
  "author": [
    {
      "display": "Harold Hippocrates, MD",
      "reference": "Practitioner/xcda-author"
    }
  ],
  "resourceType": "Composition",
  "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>"
  },
  "attester": [
    {
      "party": {
        "display": "Harold Hippocrates, MD",
        "reference": "Practitioner/xcda-author"
      },
      "mode": [
        "legal"
      ],
      "time": "2012-01-04T09:10:14Z"
    }
  ],
  "title": "Consultation Note",
  "relatesTo": [
    {
      "code": "replaces",
      "targetReference": {
        "reference": "Composition/old-example"
      }
    },
    {
      "code": "appends",
      "targetIdentifier": {
        "system": "http://example.org/fhir/NamingSystem/document-ids",
        "value": "ABC123"
      }
    }
  ],
  "event": [
    {
      "code": [
        {
          "coding": [
            {
              "code": "HEALTHREC",
              "system": "http://hl7.org/fhir/v3/ActCode",
              "display": "health record"
            }
          ]
        }
      ],
      "period": {
        "start": "2010-07-18",
        "end": "2012-11-12"
      },
      "detail": [
        {
          "reference": "Observation/example"
        }
      ]
    }
  ],
  "section": [
    {
      "code": {
        "coding": [
          {
            "code": "11348-0",
            "system": "http://loinc.org",
            "display": "History of past illness Narrative"
          }
        ]
      },
      "title": "History of present illness",
      "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>"
      },
      "orderedBy": {
        "coding": [
          {
            "code": "event-date",
            "system": "http://hl7.org/fhir/list-order",
            "display": "Sorted by Event Date"
          }
        ]
      },
      "mode": "snapshot",
      "entry": [
        {
          "reference": "Condition/stroke"
        },
        {
          "reference": "Condition/example"
        },
        {
          "reference": "Condition/example2"
        }
      ]
    },
    {
      "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>"
      },
      "code": {
        "coding": [
          {
            "code": "10157-6",
            "system": "http://loinc.org",
            "display": "History of family member diseases Narrative"
          }
        ]
      },
      "emptyReason": {
        "coding": [
          {
            "code": "withheld",
            "system": "http://hl7.org/fhir/list-empty-reason",
            "display": "Information Withheld"
          }
        ]
      },
      "mode": "snapshot",
      "title": "History of family member diseases"
    }
  ],
  "class": {
    "coding": [
      {
        "code": "LP173421-1",
        "system": "http://loinc.org",
        "display": "Report"
      }
    ]
  },
  "custodian": {
    "display": "Good Health Clinic",
    "reference": "Organization/2.16.840.1.113883.19.5"
  },
  "date": "2012-01-04T09:10:14Z",
  "identifier": {
    "system": "http://healthintersections.com.au/test",
    "value": "1"
  },
  "type": {
    "coding": [
      {
        "code": "11488-4",
        "system": "http://loinc.org",
        "display": "Consult note"
      }
    ]
  },
  "id": "example",
  "encounter": {
    "reference": "Encounter/xcda"
  },
  "subject": {
    "display": "Henry Levin the 7th",
    "reference": "Patient/xcda"
  }
}

Composition Structure


  
{
  "resourceType" : "Composition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Logical identifier of composition (version-independent)
  "status" : "<code>", // R!  preliminary | final | amended | entered-in-error
  "type" : { CodeableConcept }, // R!  Kind of composition (LOINC if possible)
  "class" : { CodeableConcept }, // Categorization of Composition
  "subject" : { Reference(Any) }, // R!  Who and/or what the composition is about
  "encounter" : { Reference(Encounter) }, // Context of the Composition
  "date" : "<dateTime>", // R!  Composition editing time
  "author" : [{ Reference(Practitioner|Device|Patient|RelatedPerson) }], // 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|Practitioner|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)
    "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/stu3/Composition?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`attester`	`reference`	`attester.party`
`author`	`reference`	`author`
`class`	`text`	`class`
`confidentiality`	`text`	`confidentiality`
`context`	`text`	`event.code`
`date`	`date`	`date`
`encounter`	`reference`	`encounter`
`entry`	`reference`	`section.entry`
`identifier`	`text`	`identifier`
`patient`	`reference`	`subject`
`period`	`date`	`event.period`
`related-id`	`text`	`relatesTo.target.as`
`related-ref`	`reference`	`relatesTo.target.as`
`section`	`text`	`section.code`
`status`	`text`	`status`
`subject`	`reference`	`subject`
`title`	`text`	`title`
`type`	`text`	`type`