Skip to main content

Composition

Trial Use 2 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​

alphahttps://api.dev.ovok.com/fhir/R4/Composition
InteractionMethodPath
ReadGET/fhir/R4/Composition/[id]
VreadGET/fhir/R4/Composition/[id]/_history/[vid]
UpdatePUT/fhir/R4/Composition/[id]
PatchPATCH/fhir/R4/Composition/[id]
DeleteDELETE/fhir/R4/Composition/[id]
CreatePOST/fhir/R4/Composition
SearchGET/fhir/R4/Composition
HistoryGET/fhir/R4/Composition/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..1Version-independent identifier for the Composition
statuscode1..1preliminary | final | amended | entered-in-error modifier
typeCodeableConcept1..1Kind of composition (LOINC if possible)
categoryCodeableConcept0..*Categorization of Composition
subjectReference0..1Who and/or what the composition is about
encounterReference0..1Context of the Composition
datedateTime1..1Composition editing time
authorReference1..*Who and/or what authored the composition
titlestring1..1Human Readable name/title
confidentialitycode0..1As defined by affinity domain
attesterBackboneElement0..*Attests to accuracy of composition
custodianReference0..1Organization which maintains the composition
relatesToBackboneElement0..*Relationships to other compositions/documents
eventBackboneElement0..*The clinical service(s) being documented
sectionBackboneElement0..*Composition is broken into sections

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
attesterstringhttp://hl7.org/fhir/SearchParameter/Composition-attester
authorstringhttp://hl7.org/fhir/SearchParameter/Composition-author
categorystringhttp://hl7.org/fhir/SearchParameter/Composition-category
confidentialitystringhttp://hl7.org/fhir/SearchParameter/Composition-confidentiality
contextstringhttp://hl7.org/fhir/SearchParameter/Composition-context
datestringhttp://hl7.org/fhir/SearchParameter/clinical-date
encounterstringhttp://hl7.org/fhir/SearchParameter/clinical-encounter
entrystringhttp://hl7.org/fhir/SearchParameter/Composition-entry
identifierstringhttp://hl7.org/fhir/SearchParameter/clinical-identifier
patientstringhttp://hl7.org/fhir/SearchParameter/clinical-patient
periodstringhttp://hl7.org/fhir/SearchParameter/Composition-period
related-idstringhttp://hl7.org/fhir/SearchParameter/Composition-related-id
related-refstringhttp://hl7.org/fhir/SearchParameter/Composition-related-ref
sectionstringhttp://hl7.org/fhir/SearchParameter/Composition-section
statusstringhttp://hl7.org/fhir/SearchParameter/Composition-status
subjectstringhttp://hl7.org/fhir/SearchParameter/Composition-subject
titlestringhttp://hl7.org/fhir/SearchParameter/Composition-title
typestringhttp://hl7.org/fhir/SearchParameter/clinical-type

Reference​

  • Official FHIR R4 spec: Composition
  • Maturity: Trial Use 2 (FMM 2).