Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Composition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_Composition_R4B | ||
This cross-version profile allows STU3 Composition content to be represented via FHIR R4B Composition resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Composition |
0..* | Composition(4.3.0) | 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 Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
 type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| date |
Σ | 1..1 | dateTime | Composition editing time |
  author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition |
   Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:author |
0..1 | Reference(Resource) | STU3: author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
 title |
Σ | 1..1 | string | Human Readable name/title |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.status | Base | required | CompositionStatus | 📍4.3.0 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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 | Composition.implicitRules, Composition.modifierExtension, Composition.status, Composition.type, Composition.date, Composition.author, Composition.author.extension, Composition.author.extension:author, Composition.title | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Composition.modifierExtension, Composition.author.extension, Composition.author.extension:author | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | Composition(4.3.0) | 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | STU3: Logical identifier of composition (version-independent) additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| category |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: LoincDocumentOntologyInternational (3.0.0) (example): High-level kind of a clinical document at a macro level. | ||||
| subject |
Σ | 0..1 | Reference(Resource) | Who and/or what the composition is about | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
1..1 | Reference(Resource) | STU3: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:encounter |
0..1 | Reference(Resource) | STU3: encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| date |
Σ | 1..1 | dateTime | Composition editing time | ||||
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:author |
0..1 | Reference(Resource) | STU3: author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| title |
Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality |
Σ | 0..1 | code | As defined by affinity domain Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester |
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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:party |
0..1 | Reference(Resource) | STU3: party URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:custodian |
0..1 | Reference(Resource) | STU3: custodian additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| relatesTo |
0..* | BackboneElement | Relationships to other compositions/documents | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:target |
0..1 | Identifier | STU3: target additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.relatesTo.target Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | ||||||
 target[x]All Types |
Content/Rules for all Types | |||||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | STU3: target additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented. | ||||
| period |
Σ | 0..1 | Period | The period covered by the documentation | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:period |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.period Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| detail |
Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:detail |
0..1 | Reference(Resource) | STU3: detail additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| section |
C | 0..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:entry |
0..1 | Reference(Resource) | STU3: entry additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Composition.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Composition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Composition.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Composition.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Composition.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Composition.status | Base | required | CompositionStatus | 📍4.3.0 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.3.0 | FHIR Std. |
| Composition.category | Base | example | LoincDocumentOntologyInternational | 📍3.0.0 | THO v7.1 |
| Composition.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.author.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.confidentiality | Base | required | http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 | 📍2.0.0 | Unknown |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.3.0 | FHIR Std. |
| Composition.attester.party.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.custodian.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.3.0 | FHIR Std. |
| Composition.event.code | Base | example | v3 Code System ActCode | 📍3.0.0 | THO v7.1 |
| Composition.event.detail.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.section.code | Base | example | Document Section Codes | 📍4.3.0 | FHIR Std. |
| Composition.section.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Composition.section.mode | Base | required | ListMode | 📍4.3.0 | FHIR Std. |
| Composition.section.orderedBy | Base | preferred | List Order Codes | 📍4.3.0 | FHIR Std. |
| Composition.section.entry.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.section.emptyReason | Base | preferred | List Empty Reasons | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | 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 | 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Composition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Composition.meta, Composition.meta.extension, Composition.meta.extension:meta, Composition.meta.versionId, Composition.meta.lastUpdated, Composition.meta.source, Composition.meta.profile, Composition.meta.security, Composition.meta.tag, Composition.implicitRules, Composition.language, Composition.text, Composition.text.extension, Composition.text.extension:text, Composition.text.status, Composition.text.div, Composition.extension, Composition.modifierExtension, Composition.identifier, Composition.identifier.extension, Composition.identifier.extension:identifier, Composition.identifier.use, Composition.identifier.type, Composition.identifier.system, Composition.identifier.value, Composition.identifier.period, Composition.identifier.assigner, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.subject.extension, Composition.subject.extension:subject, Composition.subject.reference, Composition.subject.type, Composition.subject.identifier, Composition.subject.display, Composition.encounter, Composition.encounter.extension, Composition.encounter.extension:encounter, Composition.encounter.reference, Composition.encounter.type, Composition.encounter.identifier, Composition.encounter.display, Composition.date, Composition.author, Composition.author.extension, Composition.author.extension:author, Composition.author.reference, Composition.author.type, Composition.author.identifier, Composition.author.display, Composition.title, Composition.confidentiality, Composition.attester, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode, Composition.attester.time, Composition.attester.party, Composition.attester.party.extension, Composition.attester.party.extension:party, Composition.attester.party.reference, Composition.attester.party.type, Composition.attester.party.identifier, Composition.attester.party.display, Composition.custodian, Composition.custodian.extension, Composition.custodian.extension:custodian, Composition.custodian.reference, Composition.custodian.type, Composition.custodian.identifier, Composition.custodian.display, Composition.relatesTo, Composition.relatesTo.extension, Composition.relatesTo.extension:target, Composition.relatesTo.modifierExtension, Composition.relatesTo.code, Composition.relatesTo.target[x], Composition.relatesTo.target[x].extension, Composition.relatesTo.target[x].extension:alternateReference, Composition.event, Composition.event.extension, Composition.event.modifierExtension, Composition.event.code, Composition.event.period, Composition.event.period.extension, Composition.event.period.extension:period, Composition.event.period.start, Composition.event.period.end, Composition.event.detail, Composition.event.detail.extension, Composition.event.detail.extension:detail, Composition.event.detail.reference, Composition.event.detail.type, Composition.event.detail.identifier, Composition.event.detail.display, Composition.section, Composition.section.extension, Composition.section.modifierExtension, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.focus, Composition.section.text, Composition.section.text.extension, Composition.section.text.extension:text, Composition.section.text.status, Composition.section.text.div, Composition.section.mode, Composition.section.orderedBy, Composition.section.entry, Composition.section.entry.extension, Composition.section.entry.extension:entry, Composition.section.entry.reference, Composition.section.entry.type, Composition.section.entry.identifier, Composition.section.entry.display, Composition.section.emptyReason, Composition.section.section | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Composition.meta.extension, Composition.meta.extension:meta, Composition.text.extension, Composition.text.extension:text, Composition.extension, Composition.modifierExtension, Composition.identifier.extension, Composition.identifier.extension:identifier, Composition.subject.extension, Composition.subject.extension:subject, Composition.encounter.extension, Composition.encounter.extension:encounter, Composition.author.extension, Composition.author.extension:author, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.party.extension, Composition.attester.party.extension:party, Composition.custodian.extension, Composition.custodian.extension:custodian, Composition.relatesTo.extension, Composition.relatesTo.extension:target, Composition.relatesTo.modifierExtension, Composition.relatesTo.target[x].extension, Composition.relatesTo.target[x].extension:alternateReference, Composition.event.extension, Composition.event.modifierExtension, Composition.event.period.extension, Composition.event.period.extension:period, Composition.event.detail.extension, Composition.event.detail.extension:detail, Composition.section.extension, Composition.section.modifierExtension, Composition.section.text.extension, Composition.section.text.extension:text, Composition.section.entry.extension, Composition.section.entry.extension:entry | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Composition
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
0..* | Composition(4.3.0) | 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 Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| date |
Σ | 1..1 | dateTime | Composition editing time |
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:author |
0..1 | Reference(Resource) | STU3: author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
| title |
Σ | 1..1 | string | Human Readable name/title |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.status | Base | required | CompositionStatus | 📍4.3.0 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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 | Composition.implicitRules, Composition.modifierExtension, Composition.status, Composition.type, Composition.date, Composition.author, Composition.author.extension, Composition.author.extension:author, Composition.title | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Composition.modifierExtension, Composition.author.extension, Composition.author.extension:author | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Composition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | Composition(4.3.0) | 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | STU3: Logical identifier of composition (version-independent) additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| category |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: LoincDocumentOntologyInternational (3.0.0) (example): High-level kind of a clinical document at a macro level. | ||||
| subject |
Σ | 0..1 | Reference(Resource) | Who and/or what the composition is about | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
1..1 | Reference(Resource) | STU3: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:encounter |
0..1 | Reference(Resource) | STU3: encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| date |
Σ | 1..1 | dateTime | Composition editing time | ||||
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:author |
0..1 | Reference(Resource) | STU3: author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| title |
Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality |
Σ | 0..1 | code | As defined by affinity domain Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester |
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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:party |
0..1 | Reference(Resource) | STU3: party URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:custodian |
0..1 | Reference(Resource) | STU3: custodian additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| relatesTo |
0..* | BackboneElement | Relationships to other compositions/documents | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:target |
0..1 | Identifier | STU3: target additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.relatesTo.target Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | ||||||
| target[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | STU3: target additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented. | ||||
| period |
Σ | 0..1 | Period | The period covered by the documentation | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:period |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.period Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| detail |
Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:detail |
0..1 | Reference(Resource) | STU3: detail additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| section |
C | 0..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:entry |
0..1 | Reference(Resource) | STU3: entry additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Composition.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Composition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Composition.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Composition.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Composition.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Composition.status | Base | required | CompositionStatus | 📍4.3.0 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.3.0 | FHIR Std. |
| Composition.category | Base | example | LoincDocumentOntologyInternational | 📍3.0.0 | THO v7.1 |
| Composition.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.author.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.confidentiality | Base | required | http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 | 📍2.0.0 | Unknown |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.3.0 | FHIR Std. |
| Composition.attester.party.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.custodian.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.3.0 | FHIR Std. |
| Composition.event.code | Base | example | v3 Code System ActCode | 📍3.0.0 | THO v7.1 |
| Composition.event.detail.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.section.code | Base | example | Document Section Codes | 📍4.3.0 | FHIR Std. |
| Composition.section.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Composition.section.mode | Base | required | ListMode | 📍4.3.0 | FHIR Std. |
| Composition.section.orderedBy | Base | preferred | List Order Codes | 📍4.3.0 | FHIR Std. |
| Composition.section.entry.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Composition.section.emptyReason | Base | preferred | List Empty Reasons | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | 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 | 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Composition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Composition.meta, Composition.meta.extension, Composition.meta.extension:meta, Composition.meta.versionId, Composition.meta.lastUpdated, Composition.meta.source, Composition.meta.profile, Composition.meta.security, Composition.meta.tag, Composition.implicitRules, Composition.language, Composition.text, Composition.text.extension, Composition.text.extension:text, Composition.text.status, Composition.text.div, Composition.extension, Composition.modifierExtension, Composition.identifier, Composition.identifier.extension, Composition.identifier.extension:identifier, Composition.identifier.use, Composition.identifier.type, Composition.identifier.system, Composition.identifier.value, Composition.identifier.period, Composition.identifier.assigner, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.subject.extension, Composition.subject.extension:subject, Composition.subject.reference, Composition.subject.type, Composition.subject.identifier, Composition.subject.display, Composition.encounter, Composition.encounter.extension, Composition.encounter.extension:encounter, Composition.encounter.reference, Composition.encounter.type, Composition.encounter.identifier, Composition.encounter.display, Composition.date, Composition.author, Composition.author.extension, Composition.author.extension:author, Composition.author.reference, Composition.author.type, Composition.author.identifier, Composition.author.display, Composition.title, Composition.confidentiality, Composition.attester, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode, Composition.attester.time, Composition.attester.party, Composition.attester.party.extension, Composition.attester.party.extension:party, Composition.attester.party.reference, Composition.attester.party.type, Composition.attester.party.identifier, Composition.attester.party.display, Composition.custodian, Composition.custodian.extension, Composition.custodian.extension:custodian, Composition.custodian.reference, Composition.custodian.type, Composition.custodian.identifier, Composition.custodian.display, Composition.relatesTo, Composition.relatesTo.extension, Composition.relatesTo.extension:target, Composition.relatesTo.modifierExtension, Composition.relatesTo.code, Composition.relatesTo.target[x], Composition.relatesTo.target[x].extension, Composition.relatesTo.target[x].extension:alternateReference, Composition.event, Composition.event.extension, Composition.event.modifierExtension, Composition.event.code, Composition.event.period, Composition.event.period.extension, Composition.event.period.extension:period, Composition.event.period.start, Composition.event.period.end, Composition.event.detail, Composition.event.detail.extension, Composition.event.detail.extension:detail, Composition.event.detail.reference, Composition.event.detail.type, Composition.event.detail.identifier, Composition.event.detail.display, Composition.section, Composition.section.extension, Composition.section.modifierExtension, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.focus, Composition.section.text, Composition.section.text.extension, Composition.section.text.extension:text, Composition.section.text.status, Composition.section.text.div, Composition.section.mode, Composition.section.orderedBy, Composition.section.entry, Composition.section.entry.extension, Composition.section.entry.extension:entry, Composition.section.entry.reference, Composition.section.entry.type, Composition.section.entry.identifier, Composition.section.entry.display, Composition.section.emptyReason, Composition.section.section | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Composition.meta.extension, Composition.meta.extension:meta, Composition.text.extension, Composition.text.extension:text, Composition.extension, Composition.modifierExtension, Composition.identifier.extension, Composition.identifier.extension:identifier, Composition.subject.extension, Composition.subject.extension:subject, Composition.encounter.extension, Composition.encounter.extension:encounter, Composition.author.extension, Composition.author.extension:author, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.party.extension, Composition.attester.party.extension:party, Composition.custodian.extension, Composition.custodian.extension:custodian, Composition.relatesTo.extension, Composition.relatesTo.extension:target, Composition.relatesTo.modifierExtension, Composition.relatesTo.target[x].extension, Composition.relatesTo.target[x].extension:alternateReference, Composition.event.extension, Composition.event.modifierExtension, Composition.event.period.extension, Composition.event.period.extension:period, Composition.event.detail.extension, Composition.event.detail.extension:detail, Composition.section.extension, Composition.section.modifierExtension, Composition.section.text.extension, Composition.section.text.extension:text, Composition.section.entry.extension, Composition.section.entry.extension:entry | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Composition
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r3.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
Slices for extension