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.).
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Composition/[id] |
| Vread | GET | /fhir/R4/Composition/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Composition/[id] |
| Patch | PATCH | /fhir/R4/Composition/[id] |
| Delete | DELETE | /fhir/R4/Composition/[id] |
| Create | POST | /fhir/R4/Composition |
| Search | GET | /fhir/R4/Composition |
| History | GET | /fhir/R4/Composition/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..1 | Version-independent identifier for the Composition |
status | code | 1..1 | preliminary | final | amended | entered-in-error |
type | CodeableConcept | 1..1 | Kind of composition (LOINC if possible) |
category | CodeableConcept | 0..* | Categorization of Composition |
subject | Reference | 0..1 | Who and/or what the composition is about |
encounter | Reference | 0..1 | Context of the Composition |
date | dateTime | 1..1 | Composition editing time |
author | Reference | 1..* | Who and/or what authored the composition |
title | string | 1..1 | Human Readable name/title |
confidentiality | code | 0..1 | As defined by affinity domain |
attester | BackboneElement | 0..* | Attests to accuracy of composition |
custodian | Reference | 0..1 | Organization which maintains the composition |
relatesTo | BackboneElement | 0..* | Relationships to other compositions/documents |
event | BackboneElement | 0..* | The clinical service(s) being documented |
section | BackboneElement | 0..* | Composition is broken into sections |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
attester | reference | Who attested the composition |
author | reference | Who and/or what authored the composition |
category | token | Categorization of Composition |
confidentiality | token | As defined by affinity domain |
context | token | Code(s) that apply to the event being documented |
date | date | Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made |
encounter | reference | Multiple Resources: Composition: Context of the Composition ; DeviceRequest: Encounter during which request was created ; DiagnosticReport: The Encounter when the order was made ; DocumentReference: Context of the document content ; Flag: Alert relevant during encounter ; List: Context in which list created ; NutritionOrder: Return nutrition orders with this encounter identifier ; Observation: Encounter related to the observation ; Procedure: Encounter created as part of ; RiskAssessment: Where was assessment performed? ; ServiceRequest: An encounter in which this request is made ; VisionPrescription: Return prescriptions with this encounter identifier |
entry | reference | A reference to data that supports this section |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
patient | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for |
period | date | The period covered by the documentation |
related-id | token | Target of the relationship |
related-ref | reference | Target of the relationship |
section | token | Classification of section (recommended) |
status | token | preliminary | final | amended | entered-in-error |
subject | reference | Who and/or what the composition is about |
title | string | Human Readable name/title |
type | token | Multiple Resources: AllergyIntolerance: allergy | intolerance - Underlying mechanism (if known) ; Composition: Kind of composition (LOINC if possible) ; DocumentManifest: Kind of document set ; DocumentReference: Kind of document (LOINC if possible) ; Encounter: Specific type of encounter ; EpisodeOfCare: Type/class - e.g. specialist referral, disease management |
Reference
Official FHIR R4 spec: Composition.
Maturity: Trial Use 2 (FMM 2).