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.).
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/Composition| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/Composition/[id] |
| Vread | GET | /fhir/R5/Composition/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/Composition/[id] |
| Patch | PATCH | /fhir/R5/Composition/[id] |
| Delete | DELETE | /fhir/R5/Composition/[id] |
| Create | POST | /fhir/R5/Composition |
| Search | GET | /fhir/R5/Composition?... |
| History | GET | /fhir/R5/Composition/[id]/_history |
| Type-history | GET | /fhir/R5/Composition/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Canonical identifier for this Composition, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Version-independent identifier for the Composition |
version | string | 0..1 | An explicitly assigned identifer of a variation of the content in the Composition |
status | code | 1..1 | registered |
type | CodeableConcept | 1..1 | Kind of composition (LOINC if possible) |
category | CodeableConcept | 0..* | Categorization of Composition |
subject | Reference | 0..* | Who and/or what the composition is about |
encounter | Reference | 0..1 | Context of the Composition |
date | dateTime | 1..1 | Composition editing time |
useContext | UsageContext | 0..* | The context that the content is intended to support |
author | Reference | 1..* | Who and/or what authored the composition |
name | string | 0..1 | Name for this Composition (computer friendly) |
title | string | 1..1 | Human Readable name/title |
note | Annotation | 0..* | For any additional notes |
attester | BackboneElement | 0..* | Attests to accuracy of composition |
custodian | Reference | 0..1 | Organization which maintains the composition |
relatesTo | RelatedArtifact | 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 |
date | date | When the event occurred |
encounter | reference | Encounter related to the activity recorded in the AuditEvent |
entry | reference | A reference to data that supports this section |
event-code | token | Main clinical acts documented as codes |
event-reference | reference | Main clinical acts documented as references |
identifier | token | Account number |
patient | reference | The entity that caused the expenses |
period | date | The period covered by the documentation |
related | reference | Target of the relationship |
section | token | Classification of section (recommended) |
section-code-text | composite | Search on the section narrative of the resource |
section-text | special | Search on the section narrative of the resource |
status | token | preliminary |
subject | reference | Who and/or what the composition is about |
title | string | Human Readable name/title |
type | token | E.g. patient, expense, depreciation |
url | uri | The uri that identifies the activity definition |
version | token | The business version of the activity definition |
Reference
- Official FHIR R5 spec:
Composition - Maturity: Trial Use 4 (FMM 4).