Lithuanian CVD Implementation Guide
0.0.1 - ci-build
Lithuanian CVD Implementation Guide
0.0.1 - ci-build
Lithuanian CVD Implementation Guide, published by Lithuanian Medical Library. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7LT/ig-lt-cvd/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.lt/fhir/cvd/StructureDefinition/cvd-composition-lt-cvd | Version: 1.0.0 | ||||
| Computable Name: CvdCompositionLtCvd | |||||
Combined composition for the Lithuanian CVD prevention programme containing all three sections. Use the specific profiles (CvdRiskAssessmentCompositionLtCvd, CvdPreventionPlanCompositionLtCvd, CvdAchievementCompositionLtCvd) when producing individual documents.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Composition |
0..* | CompositionLt(0.3.0) | CVD prevention programme composition (combined) | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 text |
S | 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 | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:basedOn |
0..* | Reference(Resource) | Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn Constraints: ext-1 | |
 extension:informationRecipient |
0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | CareTeam | Group) | Composition: Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient Constraints: ext-1 | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
Σ | 0..1 | uri | Canonical identifier for this Composition, represented as a URI (globally unique) Required Pattern: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CompositionEu |
| version |
SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the Composition |
| status |
?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: CvdCompositionCodeVS (1.0.0) (required) |
| category |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11488-4 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Consult note | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
 subject |
SΣ | 1..1 | Reference(PatientLt(0.3.0)) | Who and/or what the composition is about |
| encounter |
SΣ | 0..1 | Reference(EncounterLt(0.3.0)) | Context of the Composition |
| date |
SΣ | 1..1 | dateTime | Composition editing time |
| author |
SΣ | 1..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0)) | Who and/or what authored the composition |
| name |
SΣ | 0..1 | string | Name for this Composition (computer friendly) |
| title |
SΣ | 1..1 | string | Human Readable name/title |
 Slices for extension |
Content/Rules for all slices | |||
 extension:translation |
S | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1 |
| note |
S | 0..* | Annotation | For any additional notes |
| Slices for section |
SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code Constraints: cmp-1, cmp-2 |
 section:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| title |
S | 1..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. |
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | Who and/or what authored the section |
| text |
SC | 1..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 |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| entry |
SC | 0..* | Reference(Resource) | A reference to data that supports this section |
| section |
S | 0..* | See section (Composition) | Nested Section |
| section:assessment |
SC | 0..1 | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| title |
S | 1..1 | string | Label for section (e.g. for ToC) |
 code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 29299-5 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Reason for visit Narrative | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | Who and/or what authored the section |
| text |
SC | 1..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 |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| entry |
SC | 1..* | Reference(Resource) | A reference to data that supports this section |
 section |
S | 0..* | See section (Composition) | Nested Section |
| section:preventionPlan |
SC | 0..1 | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| title |
S | 1..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18776-5 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Plan of care note | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | Who and/or what authored the section |
| text |
SC | 1..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 |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| entry |
SC | 1..* | Reference(Resource) | A reference to data that supports this section |
| section |
S | 0..* | See section (Composition) | Nested Section |
 section:achievementEvaluation |
SC | 0..1 | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| title |
S | 1..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11506-3 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Progress note | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | Who and/or what authored the section |
| text |
SC | 1..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 |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| entry |
SC | 0..* | Reference(Resource) | A reference to data that supports this section |
| section |
S | 0..* | See section (Composition) | Nested Section |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.status | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| Composition.type | Base | required | CVD Composition Codes | 📍1.0.0 | This IG |
| Composition.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| Composition.section.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section, Composition.section:assessment, Composition.section:preventionPlan, Composition.section:achievementEvaluation | 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:assessment, Composition.section:preventionPlan, Composition.section:achievementEvaluation | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | Composition.implicitRules, Composition.text, Composition.extension:basedOn, Composition.extension:informationRecipient, Composition.modifierExtension, Composition.url, Composition.version, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.encounter, Composition.date, Composition.author, Composition.name, Composition.title, Composition.title.extension:translation, Composition.note, Composition.section, Composition.section.modifierExtension, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.text, Composition.section.text.status, Composition.section.text.div, Composition.section.entry, Composition.section.section, Composition.section:assessment, Composition.section:assessment.modifierExtension, Composition.section:assessment.title, Composition.section:assessment.code, Composition.section:assessment.author, Composition.section:assessment.text, Composition.section:assessment.text.status, Composition.section:assessment.text.div, Composition.section:assessment.entry, Composition.section:assessment.section, Composition.section:preventionPlan, Composition.section:preventionPlan.modifierExtension, Composition.section:preventionPlan.title, Composition.section:preventionPlan.code, Composition.section:preventionPlan.author, Composition.section:preventionPlan.text, Composition.section:preventionPlan.text.status, Composition.section:preventionPlan.text.div, Composition.section:preventionPlan.entry, Composition.section:preventionPlan.section, Composition.section:achievementEvaluation, Composition.section:achievementEvaluation.modifierExtension, Composition.section:achievementEvaluation.title, Composition.section:achievementEvaluation.code, Composition.section:achievementEvaluation.author, Composition.section:achievementEvaluation.text, Composition.section:achievementEvaluation.text.status, Composition.section:achievementEvaluation.text.div, Composition.section:achievementEvaluation.entry, Composition.section:achievementEvaluation.section | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Composition.extension:basedOn, Composition.extension:informationRecipient, Composition.modifierExtension, Composition.title.extension:translation, Composition.section.modifierExtension, Composition.section:assessment.modifierExtension, Composition.section:preventionPlan.modifierExtension, Composition.section:achievementEvaluation.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Composition.section.text.div, Composition.section:assessment.text.div, Composition.section:preventionPlan.text.div, Composition.section:achievementEvaluation.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.section.text.div, Composition.section:assessment.text.div, Composition.section:preventionPlan.text.div, Composition.section:achievementEvaluation.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
0..* | CompositionLt(0.3.0) | CVD prevention programme composition (combined) | |
| text |
S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| type |
1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: CvdCompositionCodeVS (1.0.0) (required) | |
| category |
1..* | CodeableConcept | Categorization of Composition Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11488-4 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Consult note | |
| subject |
1..1 | Reference(PatientLt(0.3.0)) | Who and/or what the composition is about | |
| author |
1..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0)) | Who and/or what authored the composition | |
| Slices for section |
1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code | |
| section:All Slices |
Content/Rules for all slices | |||
| title |
1..1 | string | Label for section (e.g. for ToC) | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) | |
| text |
S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| status |
S | 1..1 | code | generated | extensions | additional | empty |
| div |
S | 1..1 | xhtml | Limited xhtml content |
| section:assessment |
S | 0..1 | BackboneElement | Composition is broken into sections |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 29299-5 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Reason for visit Narrative | |
| entry |
1..* | Reference(Resource) | A reference to data that supports this section | |
| section:preventionPlan |
S | 0..1 | BackboneElement | Composition is broken into sections |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18776-5 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Plan of care note | |
| entry |
1..* | Reference(Resource) | A reference to data that supports this section | |
| section:achievementEvaluation |
S | 0..1 | BackboneElement | Composition is broken into sections |
 code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11506-3 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Progress note | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.type | Base | required | CVD Composition Codes | 📍1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | CompositionLt(0.3.0) | CVD prevention programme composition (combined) | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
S | 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 | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..* | Reference(Resource) | Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn Constraints: ext-1 | |||||
| extension:informationRecipient |
0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | CareTeam | Group) | Composition: Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this Composition, represented as a URI (globally unique) Required Pattern: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CompositionEu | ||||
| identifier |
Σ | 0..* | Identifier | Report identifier | ||||
| version |
SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the Composition | ||||
| status |
?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: CvdCompositionCodeVS (1.0.0) (required) | ||||
| category |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11488-4 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Consult note | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| subject |
SΣ | 1..1 | Reference(PatientLt(0.3.0)) | Who and/or what the composition is about | ||||
| encounter |
SΣ | 0..1 | Reference(EncounterLt(0.3.0)) | Context of the Composition | ||||
| date |
SΣ | 1..1 | dateTime | Composition editing time | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| author |
SΣ | 1..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0)) | Who and/or what authored the composition | ||||
| name |
SΣ | 0..1 | string | Name for this Composition (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:translation |
S | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1 | ||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| note |
S | 0..* | Annotation | For any additional notes | ||||
| 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 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): 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 | |||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents | |||||
| 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 | ||||
| period |
Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail |
Σ | 0..* | CodeableReference(Resource) | The event(s) being documented, as code(s), reference(s), or both Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented. | ||||
| Slices for section |
SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| title |
S | 1..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | ||||
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | 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 |
SC | 1..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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 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 |
S | 0..* | See section (Composition) | Nested Section | ||||
| section:assessment |
SC | 0..1 | 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 |
S | 1..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 29299-5 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Reason for visit Narrative | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | 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 |
SC | 1..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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 1..* | 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 |
S | 0..* | See section (Composition) | Nested Section | ||||
| section:preventionPlan |
SC | 0..1 | 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 |
S | 1..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18776-5 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Plan of care note | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | 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 |
SC | 1..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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 1..* | 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 |
S | 0..* | See section (Composition) | Nested Section | ||||
| section:achievementEvaluation |
SC | 0..1 | 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 |
S | 1..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11506-3 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Progress note | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | 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 |
SC | 1..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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 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 |
S | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Composition.status | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| Composition.type | Base | required | CVD Composition Codes | 📍1.0.0 | This IG |
| Composition.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| Composition.attester.mode | Base | preferred | Composition Attestation Mode | 📍5.0.0 | FHIR Std. |
| Composition.event.detail | Base | example | v3 Code System ActCode | 📍3.0.0 | THO v7.1 |
| Composition.section.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section, Composition.section:assessment, Composition.section:preventionPlan, Composition.section:achievementEvaluation | 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:assessment, Composition.section:preventionPlan, Composition.section:achievementEvaluation | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | Composition.meta, Composition.implicitRules, Composition.language, Composition.text, Composition.extension, Composition.extension:basedOn, Composition.extension:informationRecipient, Composition.modifierExtension, Composition.url, Composition.identifier, Composition.version, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.encounter, Composition.date, Composition.useContext, Composition.author, Composition.name, Composition.title, Composition.title.extension, Composition.title.extension:translation, Composition.note, Composition.attester, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode, Composition.attester.time, Composition.attester.party, Composition.custodian, Composition.relatesTo, Composition.event, Composition.event.extension, Composition.event.modifierExtension, Composition.event.period, Composition.event.detail, 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.status, Composition.section.text.div, Composition.section.orderedBy, Composition.section.entry, Composition.section.emptyReason, Composition.section.section, Composition.section:assessment, Composition.section:assessment.extension, Composition.section:assessment.modifierExtension, Composition.section:assessment.title, Composition.section:assessment.code, Composition.section:assessment.author, Composition.section:assessment.focus, Composition.section:assessment.text, Composition.section:assessment.text.extension, Composition.section:assessment.text.status, Composition.section:assessment.text.div, Composition.section:assessment.orderedBy, Composition.section:assessment.entry, Composition.section:assessment.emptyReason, Composition.section:assessment.section, Composition.section:preventionPlan, Composition.section:preventionPlan.extension, Composition.section:preventionPlan.modifierExtension, Composition.section:preventionPlan.title, Composition.section:preventionPlan.code, Composition.section:preventionPlan.author, Composition.section:preventionPlan.focus, Composition.section:preventionPlan.text, Composition.section:preventionPlan.text.extension, Composition.section:preventionPlan.text.status, Composition.section:preventionPlan.text.div, Composition.section:preventionPlan.orderedBy, Composition.section:preventionPlan.entry, Composition.section:preventionPlan.emptyReason, Composition.section:preventionPlan.section, Composition.section:achievementEvaluation, Composition.section:achievementEvaluation.extension, Composition.section:achievementEvaluation.modifierExtension, Composition.section:achievementEvaluation.title, Composition.section:achievementEvaluation.code, Composition.section:achievementEvaluation.author, Composition.section:achievementEvaluation.focus, Composition.section:achievementEvaluation.text, Composition.section:achievementEvaluation.text.extension, Composition.section:achievementEvaluation.text.status, Composition.section:achievementEvaluation.text.div, Composition.section:achievementEvaluation.orderedBy, Composition.section:achievementEvaluation.entry, Composition.section:achievementEvaluation.emptyReason, Composition.section:achievementEvaluation.section | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Composition.extension, Composition.extension:basedOn, Composition.extension:informationRecipient, Composition.modifierExtension, Composition.title.extension, Composition.title.extension:translation, Composition.attester.extension, Composition.attester.modifierExtension, Composition.event.extension, Composition.event.modifierExtension, Composition.section.extension, Composition.section.modifierExtension, Composition.section.text.extension, Composition.section:assessment.extension, Composition.section:assessment.modifierExtension, Composition.section:assessment.text.extension, Composition.section:preventionPlan.extension, Composition.section:preventionPlan.modifierExtension, Composition.section:preventionPlan.text.extension, Composition.section:achievementEvaluation.extension, Composition.section:achievementEvaluation.modifierExtension, Composition.section:achievementEvaluation.text.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Composition.section.text.div, Composition.section:assessment.text.div, Composition.section:preventionPlan.text.div, Composition.section:achievementEvaluation.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.section.text.div, Composition.section:assessment.text.div, Composition.section:preventionPlan.text.div, Composition.section:achievementEvaluation.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
Summary
Mandatory: 2 elements(4 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
0..* | CompositionLt(0.3.0) | CVD prevention programme composition (combined) | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text |
S | 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:basedOn |
0..* | Reference(Resource) | Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn Constraints: ext-1 | |
| extension:informationRecipient |
0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | CareTeam | Group) | Composition: Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient Constraints: ext-1 | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
Σ | 0..1 | uri | Canonical identifier for this Composition, represented as a URI (globally unique) Required Pattern: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CompositionEu |
| version |
SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the Composition |
| status |
?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: CvdCompositionCodeVS (1.0.0) (required) |
| category |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11488-4 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Consult note | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| subject |
SΣ | 1..1 | Reference(PatientLt(0.3.0)) | Who and/or what the composition is about |
| encounter |
SΣ | 0..1 | Reference(EncounterLt(0.3.0)) | Context of the Composition |
| date |
SΣ | 1..1 | dateTime | Composition editing time |
| author |
SΣ | 1..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0)) | Who and/or what authored the composition |
| name |
SΣ | 0..1 | string | Name for this Composition (computer friendly) |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| Slices for extension |
Content/Rules for all slices | |||
| extension:translation |
S | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1 |
| note |
S | 0..* | Annotation | For any additional notes |
| Slices for section |
SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code Constraints: cmp-1, cmp-2 |
| section:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| title |
S | 1..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. |
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | Who and/or what authored the section |
| text |
SC | 1..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 |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| entry |
SC | 0..* | Reference(Resource) | A reference to data that supports this section |
| section |
S | 0..* | See section (Composition) | Nested Section |
| section:assessment |
SC | 0..1 | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| title |
S | 1..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 29299-5 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Reason for visit Narrative | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | Who and/or what authored the section |
| text |
SC | 1..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 |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| entry |
SC | 1..* | Reference(Resource) | A reference to data that supports this section |
| section |
S | 0..* | See section (Composition) | Nested Section |
| section:preventionPlan |
SC | 0..1 | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| title |
S | 1..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18776-5 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Plan of care note | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | Who and/or what authored the section |
| text |
SC | 1..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 |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| entry |
SC | 1..* | Reference(Resource) | A reference to data that supports this section |
| section |
S | 0..* | See section (Composition) | Nested Section |
| section:achievementEvaluation |
SC | 0..1 | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| title |
S | 1..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11506-3 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Progress note | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | Who and/or what authored the section |
| text |
SC | 1..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 |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| entry |
SC | 0..* | Reference(Resource) | A reference to data that supports this section |
| section |
S | 0..* | See section (Composition) | Nested Section |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.status | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| Composition.type | Base | required | CVD Composition Codes | 📍1.0.0 | This IG |
| Composition.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| Composition.section.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section, Composition.section:assessment, Composition.section:preventionPlan, Composition.section:achievementEvaluation | 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:assessment, Composition.section:preventionPlan, Composition.section:achievementEvaluation | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | Composition.implicitRules, Composition.text, Composition.extension:basedOn, Composition.extension:informationRecipient, Composition.modifierExtension, Composition.url, Composition.version, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.encounter, Composition.date, Composition.author, Composition.name, Composition.title, Composition.title.extension:translation, Composition.note, Composition.section, Composition.section.modifierExtension, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.text, Composition.section.text.status, Composition.section.text.div, Composition.section.entry, Composition.section.section, Composition.section:assessment, Composition.section:assessment.modifierExtension, Composition.section:assessment.title, Composition.section:assessment.code, Composition.section:assessment.author, Composition.section:assessment.text, Composition.section:assessment.text.status, Composition.section:assessment.text.div, Composition.section:assessment.entry, Composition.section:assessment.section, Composition.section:preventionPlan, Composition.section:preventionPlan.modifierExtension, Composition.section:preventionPlan.title, Composition.section:preventionPlan.code, Composition.section:preventionPlan.author, Composition.section:preventionPlan.text, Composition.section:preventionPlan.text.status, Composition.section:preventionPlan.text.div, Composition.section:preventionPlan.entry, Composition.section:preventionPlan.section, Composition.section:achievementEvaluation, Composition.section:achievementEvaluation.modifierExtension, Composition.section:achievementEvaluation.title, Composition.section:achievementEvaluation.code, Composition.section:achievementEvaluation.author, Composition.section:achievementEvaluation.text, Composition.section:achievementEvaluation.text.status, Composition.section:achievementEvaluation.text.div, Composition.section:achievementEvaluation.entry, Composition.section:achievementEvaluation.section | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Composition.extension:basedOn, Composition.extension:informationRecipient, Composition.modifierExtension, Composition.title.extension:translation, Composition.section.modifierExtension, Composition.section:assessment.modifierExtension, Composition.section:preventionPlan.modifierExtension, Composition.section:achievementEvaluation.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Composition.section.text.div, Composition.section:assessment.text.div, Composition.section:preventionPlan.text.div, Composition.section:achievementEvaluation.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.section.text.div, Composition.section:assessment.text.div, Composition.section:preventionPlan.text.div, Composition.section:achievementEvaluation.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
0..* | CompositionLt(0.3.0) | CVD prevention programme composition (combined) | |
| text |
S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| type |
1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: CvdCompositionCodeVS (1.0.0) (required) | |
| category |
1..* | CodeableConcept | Categorization of Composition Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11488-4 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Consult note | |
| subject |
1..1 | Reference(PatientLt(0.3.0)) | Who and/or what the composition is about | |
| author |
1..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0)) | Who and/or what authored the composition | |
| Slices for section |
1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code | |
| section:All Slices |
Content/Rules for all slices | |||
| title |
1..1 | string | Label for section (e.g. for ToC) | |
| code |
1..1 | CodeableConcept | Classification of section (recommended) | |
| text |
S | 1..1 | Narrative | Text summary of the section, for human interpretation |
| status |
S | 1..1 | code | generated | extensions | additional | empty |
| div |
S | 1..1 | xhtml | Limited xhtml content |
| section:assessment |
S | 0..1 | BackboneElement | Composition is broken into sections |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 29299-5 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Reason for visit Narrative | |
| entry |
1..* | Reference(Resource) | A reference to data that supports this section | |
| section:preventionPlan |
S | 0..1 | BackboneElement | Composition is broken into sections |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18776-5 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Plan of care note | |
| entry |
1..* | Reference(Resource) | A reference to data that supports this section | |
| section:achievementEvaluation |
S | 0..1 | BackboneElement | Composition is broken into sections |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11506-3 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Progress note | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.type | Base | required | CVD Composition Codes | 📍1.0.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | CompositionLt(0.3.0) | CVD prevention programme composition (combined) | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
S | 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..* | Reference(Resource) | Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn Constraints: ext-1 | |||||
| extension:informationRecipient |
0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | CareTeam | Group) | Composition: Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this Composition, represented as a URI (globally unique) Required Pattern: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CompositionEu | ||||
| identifier |
Σ | 0..* | Identifier | Report identifier | ||||
| version |
SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the Composition | ||||
| status |
?!SΣ | 1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: CvdCompositionCodeVS (1.0.0) (required) | ||||
| category |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11488-4 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Consult note | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| subject |
SΣ | 1..1 | Reference(PatientLt(0.3.0)) | Who and/or what the composition is about | ||||
| encounter |
SΣ | 0..1 | Reference(EncounterLt(0.3.0)) | Context of the Composition | ||||
| date |
SΣ | 1..1 | dateTime | Composition editing time | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| author |
SΣ | 1..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0)) | Who and/or what authored the composition | ||||
| name |
SΣ | 0..1 | string | Name for this Composition (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:translation |
S | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation Constraints: ext-1 | ||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| note |
S | 0..* | Annotation | For any additional notes | ||||
| 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 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): 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 | |||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents | |||||
| 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 | ||||
| period |
Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail |
Σ | 0..* | CodeableReference(Resource) | The event(s) being documented, as code(s), reference(s), or both Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented. | ||||
| Slices for section |
SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| title |
S | 1..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | ||||
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | 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 |
SC | 1..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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 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 |
S | 0..* | See section (Composition) | Nested Section | ||||
| section:assessment |
SC | 0..1 | 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 |
S | 1..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 29299-5 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Reason for visit Narrative | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | 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 |
SC | 1..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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 1..* | 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 |
S | 0..* | See section (Composition) | Nested Section | ||||
| section:preventionPlan |
SC | 0..1 | 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 |
S | 1..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18776-5 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Plan of care note | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | 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 |
SC | 1..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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 1..* | 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 |
S | 0..* | See section (Composition) | Nested Section | ||||
| section:achievementEvaluation |
SC | 0..1 | 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 |
S | 1..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11506-3 | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Progress note | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
S | 0..* | Reference(PractitionerLt(0.3.0) | PractitionerRoleLt(0.3.0) | OrganizationLt(0.3.0) | PatientLt(0.3.0) | RelatedPersonLt(0.3.0) | Device) | 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 |
SC | 1..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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 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 |
S | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Composition.status | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| Composition.type | Base | required | CVD Composition Codes | 📍1.0.0 | This IG |
| Composition.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| Composition.attester.mode | Base | preferred | Composition Attestation Mode | 📍5.0.0 | FHIR Std. |
| Composition.event.detail | Base | example | v3 Code System ActCode | 📍3.0.0 | THO v7.1 |
| Composition.section.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:assessment.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:preventionPlan.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.code | Base | example | Document Section Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| Composition.section:achievementEvaluation.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section, Composition.section:assessment, Composition.section:preventionPlan, Composition.section:achievementEvaluation | 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:assessment, Composition.section:preventionPlan, Composition.section:achievementEvaluation | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | Composition.meta, Composition.implicitRules, Composition.language, Composition.text, Composition.extension, Composition.extension:basedOn, Composition.extension:informationRecipient, Composition.modifierExtension, Composition.url, Composition.identifier, Composition.version, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.encounter, Composition.date, Composition.useContext, Composition.author, Composition.name, Composition.title, Composition.title.extension, Composition.title.extension:translation, Composition.note, Composition.attester, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode, Composition.attester.time, Composition.attester.party, Composition.custodian, Composition.relatesTo, Composition.event, Composition.event.extension, Composition.event.modifierExtension, Composition.event.period, Composition.event.detail, 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.status, Composition.section.text.div, Composition.section.orderedBy, Composition.section.entry, Composition.section.emptyReason, Composition.section.section, Composition.section:assessment, Composition.section:assessment.extension, Composition.section:assessment.modifierExtension, Composition.section:assessment.title, Composition.section:assessment.code, Composition.section:assessment.author, Composition.section:assessment.focus, Composition.section:assessment.text, Composition.section:assessment.text.extension, Composition.section:assessment.text.status, Composition.section:assessment.text.div, Composition.section:assessment.orderedBy, Composition.section:assessment.entry, Composition.section:assessment.emptyReason, Composition.section:assessment.section, Composition.section:preventionPlan, Composition.section:preventionPlan.extension, Composition.section:preventionPlan.modifierExtension, Composition.section:preventionPlan.title, Composition.section:preventionPlan.code, Composition.section:preventionPlan.author, Composition.section:preventionPlan.focus, Composition.section:preventionPlan.text, Composition.section:preventionPlan.text.extension, Composition.section:preventionPlan.text.status, Composition.section:preventionPlan.text.div, Composition.section:preventionPlan.orderedBy, Composition.section:preventionPlan.entry, Composition.section:preventionPlan.emptyReason, Composition.section:preventionPlan.section, Composition.section:achievementEvaluation, Composition.section:achievementEvaluation.extension, Composition.section:achievementEvaluation.modifierExtension, Composition.section:achievementEvaluation.title, Composition.section:achievementEvaluation.code, Composition.section:achievementEvaluation.author, Composition.section:achievementEvaluation.focus, Composition.section:achievementEvaluation.text, Composition.section:achievementEvaluation.text.extension, Composition.section:achievementEvaluation.text.status, Composition.section:achievementEvaluation.text.div, Composition.section:achievementEvaluation.orderedBy, Composition.section:achievementEvaluation.entry, Composition.section:achievementEvaluation.emptyReason, Composition.section:achievementEvaluation.section | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Composition.extension, Composition.extension:basedOn, Composition.extension:informationRecipient, Composition.modifierExtension, Composition.title.extension, Composition.title.extension:translation, Composition.attester.extension, Composition.attester.modifierExtension, Composition.event.extension, Composition.event.modifierExtension, Composition.section.extension, Composition.section.modifierExtension, Composition.section.text.extension, Composition.section:assessment.extension, Composition.section:assessment.modifierExtension, Composition.section:assessment.text.extension, Composition.section:preventionPlan.extension, Composition.section:preventionPlan.modifierExtension, Composition.section:preventionPlan.text.extension, Composition.section:achievementEvaluation.extension, Composition.section:achievementEvaluation.modifierExtension, Composition.section:achievementEvaluation.text.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Composition.section.text.div, Composition.section:assessment.text.div, Composition.section:preventionPlan.text.div, Composition.section:achievementEvaluation.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.section.text.div, Composition.section:assessment.text.div, Composition.section:preventionPlan.text.div, Composition.section:achievementEvaluation.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
Summary
Mandatory: 2 elements(4 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron