FHIR Implementation Guide for ABDM
7.0.0 - active India flag

Banner

FHIR Implementation Guide for ABDM - Local Development build (v7.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: WellnessRecord

Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/WellnessRecord Version: 7.0.0
Draft as of 2025-03-18 Computable Name: WellnessRecord

The Clinical Artifact represents regular wellness information of patients typically through the Patient Health Record (PHR) application covering clinical information such as vitals, physical examination, general wellness, women wellness, etc., that can be shared across the health ecosystem.

This profile sets minimum expectations for the WellnessRecord to record, search, and fetch the details of daily observations such as vital signs, body measurements, physical activities, etc. collected via various healthcare devices by a patient. It identifies the mandatory core elements, vocabularies, and value sets which SHALL be present in the Composition resource when using this profile.

Examples

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
.... text SΣ 0..1 string Plain text representation of the concept
Fixed Value: Wellness Record
... subject SΣ 1..1 Reference(Patient) Who and/or what the composition is about
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date SΣ 1..1 dateTime Composition editing time
... author SΣ 1..* Reference(Device | RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who and/or what authored the composition
... title SΣ 1..1 string Human Readable name/title
... attester S 0..* BackboneElement Attests to accuracy of composition
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
.... party 0..1 Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian Σ 0..1 Reference(Organization) Organization which maintains the composition
... Slices for section SC 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open At End by value:title
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... section:VitalSigns C 0..1 BackboneElement The Section records the patient's body's basic functions such as blood pressure, heart rate, respiratory rate etc.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Vital Signs
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | Organization) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationVitalSigns) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:BodyMeasurement C 0..1 BackboneElement The section records various body measurements that are important for assessing a patient's health, such as weight, height, BMI, and waist circumference.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Body Measurement
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationBodyMeasurement) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:PhysicalActivity C 0..1 BackboneElement The section records information about the patient's physical activities, including exercise routines, frequency, intensity, and type of activities
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Physical Activity
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationPhysicalActivity) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:GeneralAssessment C 0..1 BackboneElement The section includes general assessments of the patient's overall health status, such as physical examination findings and health risk assessments.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: General Assessment
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationGeneralAssessment) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:WomenHealth C 0..1 BackboneElement The section focuses on health information specific to women, including reproductive health, menstrual cycle and other gynecological assessments.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Women Health
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationWomenHealth) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:Lifestyle C 0..1 BackboneElement The section records lifestyle factors that can impact health, such as smoking status, alcohol consumption, diet, and sleep patterns.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Lifestyle
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationLifestyle) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:OtherObservations C 0..1 BackboneElement The section includes any other relevant observations such as additional laboratory results or patient-reported outcomes.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Other Observations
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(Observation | Condition) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:DocumentReference C 0..1 BackboneElement The section records documents, such as PDFs or images,
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Document Reference
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | Organization) Who and/or what authored the section
..... entry SC 0..* Reference(DocumentReference) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section, Composition.section:VitalSigns, Composition.section:BodyMeasurement, Composition.section:PhysicalActivity, Composition.section:GeneralAssessment, Composition.section:WomenHealth, Composition.section:Lifestyle, Composition.section:OtherObservations, Composition.section:DocumentReference A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section, Composition.section:VitalSigns, Composition.section:BodyMeasurement, Composition.section:PhysicalActivity, Composition.section:GeneralAssessment, Composition.section:WomenHealth, Composition.section:Lifestyle, Composition.section:OtherObservations, Composition.section:DocumentReference A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... status S 1..1 code preliminary | final | amended | entered-in-error
... type S 1..1 CodeableConcept Kind of composition (LOINC if possible)
.... text S 0..1 string Plain text representation of the concept
Fixed Value: Wellness Record
... subject S 1..1 Reference(Patient) Who and/or what the composition is about
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... date S 1..1 dateTime Composition editing time
... author S 1..* Reference(Device | RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who and/or what authored the composition
... title S 1..1 string Human Readable name/title
... attester S 0..* BackboneElement Attests to accuracy of composition
.... party 0..1 Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian 0..1 Reference(Organization) Organization which maintains the composition
... Slices for section S 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open At End by value:title
.... section:VitalSigns 0..1 BackboneElement The Section records the patient's body's basic functions such as blood pressure, heart rate, respiratory rate etc.
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Vital Signs
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | Organization) Who and/or what authored the section
..... entry S 0..* Reference(ObservationVitalSigns) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:BodyMeasurement 0..1 BackboneElement The section records various body measurements that are important for assessing a patient's health, such as weight, height, BMI, and waist circumference.
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Body Measurement
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationBodyMeasurement) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:PhysicalActivity 0..1 BackboneElement The section records information about the patient's physical activities, including exercise routines, frequency, intensity, and type of activities
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Physical Activity
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationPhysicalActivity) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:GeneralAssessment 0..1 BackboneElement The section includes general assessments of the patient's overall health status, such as physical examination findings and health risk assessments.
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: General Assessment
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationGeneralAssessment) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:WomenHealth 0..1 BackboneElement The section focuses on health information specific to women, including reproductive health, menstrual cycle and other gynecological assessments.
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Women Health
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationWomenHealth) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:Lifestyle 0..1 BackboneElement The section records lifestyle factors that can impact health, such as smoking status, alcohol consumption, diet, and sleep patterns.
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Lifestyle
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationLifestyle) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:OtherObservations 0..1 BackboneElement The section includes any other relevant observations such as additional laboratory results or patient-reported outcomes.
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Other Observations
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(Observation | Condition) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:DocumentReference 0..1 BackboneElement The section records documents, such as PDFs or images,
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Document Reference
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | Organization) Who and/or what authored the section
..... entry S 0..* Reference(DocumentReference) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Version-independent identifier for the Composition
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
Fixed Value: Wellness Record
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject SΣ 1..1 Reference(Patient) Who and/or what the composition is about
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date SΣ 1..1 dateTime Composition editing time
... author SΣ 1..* Reference(Device | RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who and/or what authored the composition
... title SΣ 1..1 string Human Readable name/title
... confidentiality Σ 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
... attester S 0..* BackboneElement Attests to accuracy of composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
.... time 0..1 dateTime When the composition was attested
.... party 0..1 Reference(RelatedPerson | Patient | 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* Reference(Resource) The event(s) being documented
... Slices for section SC 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open At End by value:title
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string Label for section (e.g. for ToC)
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry C 0..* Reference(Resource) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:VitalSigns C 0..1 BackboneElement The Section records the patient's body's basic functions such as blood pressure, heart rate, respiratory rate etc.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Vital Signs
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationVitalSigns) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:BodyMeasurement C 0..1 BackboneElement The section records various body measurements that are important for assessing a patient's health, such as weight, height, BMI, and waist circumference.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Body Measurement
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationBodyMeasurement) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:PhysicalActivity C 0..1 BackboneElement The section records information about the patient's physical activities, including exercise routines, frequency, intensity, and type of activities
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Physical Activity
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationPhysicalActivity) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:GeneralAssessment C 0..1 BackboneElement The section includes general assessments of the patient's overall health status, such as physical examination findings and health risk assessments.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: General Assessment
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationGeneralAssessment) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:WomenHealth C 0..1 BackboneElement The section focuses on health information specific to women, including reproductive health, menstrual cycle and other gynecological assessments.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Women Health
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationWomenHealth) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:Lifestyle C 0..1 BackboneElement The section records lifestyle factors that can impact health, such as smoking status, alcohol consumption, diet, and sleep patterns.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Lifestyle
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationLifestyle) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:OtherObservations C 0..1 BackboneElement The section includes any other relevant observations such as additional laboratory results or patient-reported outcomes.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Other Observations
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Observation | Condition) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:DocumentReference C 0..1 BackboneElement The section records documents, such as PDFs or images,
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Document Reference
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(DocumentReference) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section, Composition.section:VitalSigns, Composition.section:BodyMeasurement, Composition.section:PhysicalActivity, Composition.section:GeneralAssessment, Composition.section:WomenHealth, Composition.section:Lifestyle, Composition.section:OtherObservations, Composition.section:DocumentReference A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section, Composition.section:VitalSigns, Composition.section:BodyMeasurement, Composition.section:PhysicalActivity, Composition.section:GeneralAssessment, Composition.section:WomenHealth, Composition.section:Lifestyle, Composition.section:OtherObservations, Composition.section:DocumentReference A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 3 elements(16 nested mandatory elements)
Must-Support: 20 elements
Fixed: 9 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Composition.section (Open at End)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
.... text SΣ 0..1 string Plain text representation of the concept
Fixed Value: Wellness Record
... subject SΣ 1..1 Reference(Patient) Who and/or what the composition is about
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date SΣ 1..1 dateTime Composition editing time
... author SΣ 1..* Reference(Device | RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who and/or what authored the composition
... title SΣ 1..1 string Human Readable name/title
... attester S 0..* BackboneElement Attests to accuracy of composition
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
.... party 0..1 Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian Σ 0..1 Reference(Organization) Organization which maintains the composition
... Slices for section SC 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open At End by value:title
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... section:VitalSigns C 0..1 BackboneElement The Section records the patient's body's basic functions such as blood pressure, heart rate, respiratory rate etc.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Vital Signs
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | Organization) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationVitalSigns) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:BodyMeasurement C 0..1 BackboneElement The section records various body measurements that are important for assessing a patient's health, such as weight, height, BMI, and waist circumference.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Body Measurement
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationBodyMeasurement) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:PhysicalActivity C 0..1 BackboneElement The section records information about the patient's physical activities, including exercise routines, frequency, intensity, and type of activities
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Physical Activity
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationPhysicalActivity) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:GeneralAssessment C 0..1 BackboneElement The section includes general assessments of the patient's overall health status, such as physical examination findings and health risk assessments.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: General Assessment
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationGeneralAssessment) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:WomenHealth C 0..1 BackboneElement The section focuses on health information specific to women, including reproductive health, menstrual cycle and other gynecological assessments.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Women Health
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationWomenHealth) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:Lifestyle C 0..1 BackboneElement The section records lifestyle factors that can impact health, such as smoking status, alcohol consumption, diet, and sleep patterns.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Lifestyle
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(ObservationLifestyle) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:OtherObservations C 0..1 BackboneElement The section includes any other relevant observations such as additional laboratory results or patient-reported outcomes.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Other Observations
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry SC 0..* Reference(Observation | Condition) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... section:DocumentReference C 0..1 BackboneElement The section records documents, such as PDFs or images,
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Document Reference
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | Organization) Who and/or what authored the section
..... entry SC 0..* Reference(DocumentReference) A reference to data that supports this section
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section, Composition.section:VitalSigns, Composition.section:BodyMeasurement, Composition.section:PhysicalActivity, Composition.section:GeneralAssessment, Composition.section:WomenHealth, Composition.section:Lifestyle, Composition.section:OtherObservations, Composition.section:DocumentReference A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section, Composition.section:VitalSigns, Composition.section:BodyMeasurement, Composition.section:PhysicalActivity, Composition.section:GeneralAssessment, Composition.section:WomenHealth, Composition.section:Lifestyle, Composition.section:OtherObservations, Composition.section:DocumentReference A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... status S 1..1 code preliminary | final | amended | entered-in-error
... type S 1..1 CodeableConcept Kind of composition (LOINC if possible)
.... text S 0..1 string Plain text representation of the concept
Fixed Value: Wellness Record
... subject S 1..1 Reference(Patient) Who and/or what the composition is about
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... date S 1..1 dateTime Composition editing time
... author S 1..* Reference(Device | RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who and/or what authored the composition
... title S 1..1 string Human Readable name/title
... attester S 0..* BackboneElement Attests to accuracy of composition
.... party 0..1 Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian 0..1 Reference(Organization) Organization which maintains the composition
... Slices for section S 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open At End by value:title
.... section:VitalSigns 0..1 BackboneElement The Section records the patient's body's basic functions such as blood pressure, heart rate, respiratory rate etc.
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Vital Signs
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | Organization) Who and/or what authored the section
..... entry S 0..* Reference(ObservationVitalSigns) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:BodyMeasurement 0..1 BackboneElement The section records various body measurements that are important for assessing a patient's health, such as weight, height, BMI, and waist circumference.
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Body Measurement
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationBodyMeasurement) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:PhysicalActivity 0..1 BackboneElement The section records information about the patient's physical activities, including exercise routines, frequency, intensity, and type of activities
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Physical Activity
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationPhysicalActivity) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:GeneralAssessment 0..1 BackboneElement The section includes general assessments of the patient's overall health status, such as physical examination findings and health risk assessments.
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: General Assessment
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationGeneralAssessment) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:WomenHealth 0..1 BackboneElement The section focuses on health information specific to women, including reproductive health, menstrual cycle and other gynecological assessments.
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Women Health
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationWomenHealth) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:Lifestyle 0..1 BackboneElement The section records lifestyle factors that can impact health, such as smoking status, alcohol consumption, diet, and sleep patterns.
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Lifestyle
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(ObservationLifestyle) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:OtherObservations 0..1 BackboneElement The section includes any other relevant observations such as additional laboratory results or patient-reported outcomes.
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Other Observations
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) Who and/or what authored the section
..... entry S 0..* Reference(Observation | Condition) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... section:DocumentReference 0..1 BackboneElement The section records documents, such as PDFs or images,
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Document Reference
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | Organization) Who and/or what authored the section
..... entry S 0..* Reference(DocumentReference) A reference to data that supports this section
...... reference 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Version-independent identifier for the Composition
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
Fixed Value: Wellness Record
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject SΣ 1..1 Reference(Patient) Who and/or what the composition is about
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date SΣ 1..1 dateTime Composition editing time
... author SΣ 1..* Reference(Device | RelatedPerson | Patient | Practitioner | PractitionerRole | Organization) Who and/or what authored the composition
... title SΣ 1..1 string Human Readable name/title
... confidentiality Σ 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
... attester S 0..* BackboneElement Attests to accuracy of composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
.... time 0..1 dateTime When the composition was attested
.... party 0..1 Reference(RelatedPerson | Patient | 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* Reference(Resource) The event(s) being documented
... Slices for section SC 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open At End by value:title
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string Label for section (e.g. for ToC)
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry C 0..* Reference(Resource) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:VitalSigns C 0..1 BackboneElement The Section records the patient's body's basic functions such as blood pressure, heart rate, respiratory rate etc.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Vital Signs
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationVitalSigns) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:BodyMeasurement C 0..1 BackboneElement The section records various body measurements that are important for assessing a patient's health, such as weight, height, BMI, and waist circumference.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Body Measurement
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationBodyMeasurement) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:PhysicalActivity C 0..1 BackboneElement The section records information about the patient's physical activities, including exercise routines, frequency, intensity, and type of activities
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Physical Activity
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationPhysicalActivity) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:GeneralAssessment C 0..1 BackboneElement The section includes general assessments of the patient's overall health status, such as physical examination findings and health risk assessments.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: General Assessment
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationGeneralAssessment) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:WomenHealth C 0..1 BackboneElement The section focuses on health information specific to women, including reproductive health, menstrual cycle and other gynecological assessments.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Women Health
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationWomenHealth) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:Lifestyle C 0..1 BackboneElement The section records lifestyle factors that can impact health, such as smoking status, alcohol consumption, diet, and sleep patterns.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Lifestyle
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(ObservationLifestyle) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:OtherObservations C 0..1 BackboneElement The section includes any other relevant observations such as additional laboratory results or patient-reported outcomes.
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
Fixed Value: Other Observations
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Organization | Patient | PractitionerRole | Practitioner) 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Observation | Condition) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:DocumentReference C 0..1 BackboneElement The section records documents, such as PDFs or images,
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
Fixed Value: Document Reference
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(Device | RelatedPerson | Practitioner | PractitionerRole | Patient | 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(DocumentReference) A reference to data that supports this section
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:VitalSigns.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:BodyMeasurement.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:PhysicalActivity.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:GeneralAssessment.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:WomenHealth.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:Lifestyle.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:OtherObservations.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​entry.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:DocumentReference.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section, Composition.section:VitalSigns, Composition.section:BodyMeasurement, Composition.section:PhysicalActivity, Composition.section:GeneralAssessment, Composition.section:WomenHealth, Composition.section:Lifestyle, Composition.section:OtherObservations, Composition.section:DocumentReference A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section, Composition.section:VitalSigns, Composition.section:BodyMeasurement, Composition.section:PhysicalActivity, Composition.section:GeneralAssessment, Composition.section:WomenHealth, Composition.section:Lifestyle, Composition.section:OtherObservations, Composition.section:DocumentReference A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 3 elements(16 nested mandatory elements)
Must-Support: 20 elements
Fixed: 9 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Composition.section (Open at End)

 

Other representations of profile: CSV, Excel, Schematron