Skip to main content

Composition

Trial Use 4 Foundation

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

devhttps://api.sandbox.ovok.com/fhir/R5/Composition
InteractionMethodPath
ReadGET/fhir/R5/Composition/[id]
VreadGET/fhir/R5/Composition/[id]/_history/[vid]
UpdatePUT/fhir/R5/Composition/[id]
PatchPATCH/fhir/R5/Composition/[id]
DeleteDELETE/fhir/R5/Composition/[id]
CreatePOST/fhir/R5/Composition
SearchGET/fhir/R5/Composition?...
HistoryGET/fhir/R5/Composition/[id]/_history
Type-historyGET/fhir/R5/Composition/_history

Top-level elements

ElementType(s)CardinalityDescription
urluri0..1Canonical identifier for this Composition, represented as a URI (globally unique)
identifierIdentifier0..*Version-independent identifier for the Composition
versionstring0..1An explicitly assigned identifer of a variation of the content in the Composition
statuscode1..1registered
typeCodeableConcept1..1Kind of composition (LOINC if possible)
categoryCodeableConcept0..*Categorization of Composition
subjectReference0..*Who and/or what the composition is about
encounterReference0..1Context of the Composition
datedateTime1..1Composition editing time
useContextUsageContext0..*The context that the content is intended to support
authorReference1..*Who and/or what authored the composition
namestring0..1Name for this Composition (computer friendly)
titlestring1..1Human Readable name/title
noteAnnotation0..*For any additional notes
attesterBackboneElement0..*Attests to accuracy of composition
custodianReference0..1Organization which maintains the composition
relatesToRelatedArtifact0..*Relationships to other compositions/documents
eventBackboneElement0..*The clinical service(s) being documented
sectionBackboneElement0..*Composition is broken into sections

Resource-specific search parameters

ParameterTypeDescription
attesterreferenceWho attested the composition
authorreferenceWho and/or what authored the composition
categorytokenCategorization of Composition
datedateWhen the event occurred
encounterreferenceEncounter related to the activity recorded in the AuditEvent
entryreferenceA reference to data that supports this section
event-codetokenMain clinical acts documented as codes
event-referencereferenceMain clinical acts documented as references
identifiertokenAccount number
patientreferenceThe entity that caused the expenses
perioddateThe period covered by the documentation
relatedreferenceTarget of the relationship
sectiontokenClassification of section (recommended)
section-code-textcompositeSearch on the section narrative of the resource
section-textspecialSearch on the section narrative of the resource
statustokenpreliminary
subjectreferenceWho and/or what the composition is about
titlestringHuman Readable name/title
typetokenE.g. patient, expense, depreciation
urluriThe uri that identifies the activity definition
versiontokenThe business version of the activity definition

Reference

  • Official FHIR R5 spec: Composition
  • Maturity: Trial Use 4 (FMM 4).