Composition

ResourceFoundation · DocumentsTrial useMaturity 2

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.).

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

18 of 18 parameters tested

Structure

Show inherited elements (20)

Element	Card.	Type	Description
identifierΣ	0..1	Identifier	Version-independent identifier for the Composition
statusRequired?!Σ	1..1	code	preliminary | final | amended | entered-in-errorBinding (required): composition-status
typeRequiredΣ	1..1	CodeableConcept	Kind of composition (LOINC if possible)Binding (preferred): doc-typecodes
categoryΣ	0..*	CodeableConcept	Categorization of CompositionBinding (example): document-classcodes
subjectΣ	0..1	Reference(Resource)	Who and/or what the composition is about
encounterΣ	0..1	Reference(Encounter)	Context of the Composition
dateRequiredΣ	1..1	dateTime	Composition editing time
authorRequiredΣ	1..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the composition
titleRequiredΣ	1..1	string	Human Readable name/title
confidentialityΣ	0..1	code	As defined by affinity domainBinding (required): v3-ConfidentialityClassification
attester	0..*	BackboneElement	Attests to accuracy of composition
modeRequired	1..1	code	personal | professional | legal | officialBinding (required): composition-attestation-mode
time	0..1	dateTime	When the composition was attested
party	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)	Who attested the composition
custodianΣ	0..1	Reference(Organization)	Organization which maintains the composition
relatesTo	0..*	BackboneElement	Relationships to other compositions/documents
codeRequired	1..1	code	replaces | transforms | signs | appendsBinding (required): document-relationship-type
target[x]Required	1..1	Identifier | Reference(Composition)	Target of the relationship
eventΣ	0..*	BackboneElement	The clinical service(s) being documented
codeΣ	0..*	CodeableConcept	Code(s) that apply to the event being documentedBinding (example): v3-ActCode
periodΣ	0..1	Period	The period covered by the documentation
detailΣ	0..*	Reference(Resource)	The event(s) being documented
section	0..*	BackboneElement	Composition is broken into sections
title	0..1	string	Label for section (e.g. for ToC)
code	0..1	CodeableConcept	Classification of section (recommended)Binding (example): doc-section-codes
author	0..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the section
focus	0..1	Reference(Resource)	Who/what the section is about, when it is not about the subject of composition
text	0..1	Narrative	Text summary of the section, for human interpretation
mode	0..1	code	working | snapshot | changesBinding (required): list-mode
orderedBy	0..1	CodeableConcept	Order of section entriesBinding (preferred): list-order
entry	0..*	Reference(Resource)	A reference to data that supports this section
emptyReason	0..1	CodeableConcept	Why the section is emptyBinding (preferred): list-empty-reason
section	0..*	Same as Composition.section	Nested Section

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Composition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
attester	reference	Who attested the composition Composition.attester.party
author	reference	Who and/or what authored the composition Composition.author
category	token	Categorization of Composition Composition.category
confidentiality	token	As defined by affinity domain Composition.confidentiality
context	token	Code(s) that apply to the event being documented Composition.event.code
date	date	Composition editing time Composition.date
encounter	reference	Context of the Composition Composition.encounter
entry	reference	A reference to data that supports this section Composition.section.entry
identifier	token	Version-independent identifier for the Composition Composition.identifier
patient	reference	Who and/or what the composition is about Composition.subject.where(resolve() is Patient)
period	date	The period covered by the documentation Composition.event.period
related-id	token	Target of the relationship (Composition.relatesTo.target.ofType(Identifier))
related-ref	reference	Target of the relationship (Composition.relatesTo.target.ofType(Reference))
section	token	Classification of section (recommended) Composition.section.code
status	token	preliminary | final | amended | entered-in-error Composition.status
subject	reference	Who and/or what the composition is about Composition.subject
title	string	Human Readable name/title Composition.title
type	token	Kind of composition (LOINC if possible) Composition.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition