CH Core (R4)
4.0.1 - trial-use
CH Core (R4)
4.0.1 - trial-use
This page is part of the CH Core (R4) (v4.0.1: STU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-composition-epr | Version: 4.0.1 | |||
| Active as of 2023-12-28 | Computable Name: CHCoreCompositionEPR | |||
Copyright/Legal: CC0-1.0 |
||||
Base definition for a composition in the context of the electronic patient record (EPR).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHCoreComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | 0..* | CHCoreComposition | CH Core Composition EPR | |
  language | 1..1 | code | Language of the resource content | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 informationRecipient | 0..* | Reference(CH Core Practitioner | CH Core Patient | RelatedPerson | CH Core Organization) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-informationrecipient | |
| dataEnterer | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer | |
 identifier | 1..1 | Identifier | Version-independent identifier for the Composition | |
 system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
 value | 1..1 | string | The value that is unique | |
| type | 1..1 | CodeableConcept | Kind of composition Binding: DocumentEntry.typeCode (extensible) | |
 subject | 1..1 | Reference(CH Core Patient EPR) | Who and/or what the composition is about | |
| author | 1..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the composition | |
| time | 0..1 | dateTime | Timestamp of the authorship/data input URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-time | |
| confidentiality | 1..1 | code | As defined by affinity domain | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| confidentialityCode | 1..1 | CodeableConcept | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-confidentialitycode Binding: DocumentEntry.confidentialityCode (extensible) | |
 Slices for attester | 0..* | BackboneElement | Attests to accuracy of composition Slice: Unordered, Open by value:mode | |
 attester:legalAuthenticator | 0..1 | BackboneElement | legal authenticator | |
  mode | 1..1 | code | personal | professional | legal | official Fixed Value: legal | |
 party | 1..1 | Reference(CH Core Patient EPR | RelatedPerson | CH Core Practitioner EPR | CH Core PractitionerRole EPR) | Who attested the composition | |
| custodian | 0..1 | Reference(CH Core Organization EPR) | Organization which maintains the composition | |
| relatesTo | ||||
  target[x] | 1..1 | Target of the relationship | ||
 targetIdentifier | Identifier | |||
| targetReference | Reference(CH Core Composition EPR) | |||
| Slices for section | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code | |
 section:All Slices | Content/Rules for all slices | |||
  author | 0..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the section | |
| section:originalRepresentation | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. | |
| title | 1..1 | string | Original representation | |
 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: 55108-5 | |
| text | 1..1 | Narrative | Representation of the original view | |
| entry | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. | |
| narrativeLink | 0..1 | url | narrativeLink to img src attribute URL: http://hl7.org/fhir/StructureDefinition/narrativeLink | |
| section | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Composition.type | extensible | DocumentEntryTypeCode |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH Core Composition EPR | |||||
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| informationRecipient | 0..* | Reference(CH Core Practitioner | CH Core Patient | RelatedPerson | CH Core Organization) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-informationrecipient | |||||
| dataEnterer | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | Version-independent identifier for the Composition | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of composition Binding: DocumentEntry.typeCode (extensible) | ||||
| subject | Σ | 1..1 | Reference(CH Core Patient EPR) | Who and/or what the composition is about | ||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | Σ | 1..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the composition | ||||
| time | 0..1 | dateTime | Timestamp of the authorship/data input URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-time | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| title | Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 1..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| confidentialityCode | 1..1 | CodeableConcept | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-confidentialitycode Binding: DocumentEntry.confidentialityCode (extensible) | |||||
| Slices for attester | 0..* | BackboneElement | Attests to accuracy of composition Slice: Unordered, Open by value:mode | |||||
| attester:All Slices | Content/Rules for all slices | |||||||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| attester:legalAuthenticator | 0..1 | BackboneElement | legal authenticator | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. Fixed Value: legal | |||||
 party | 1..1 | Reference(CH Core Patient EPR | RelatedPerson | CH Core Practitioner EPR | CH Core PractitionerRole EPR) | Who attested the composition | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| custodian | Σ | 0..1 | Reference(CH Core Organization EPR) | Organization which maintains the composition | ||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code | ||||
| section:All Slices | Content/Rules for all slices | |||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| author | 0..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the section | |||||
| section:originalRepresentation | C | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 1..1 | string | Original representation | |||||
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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: 55108-5 | |||||
| text | C | 1..1 | Narrative | Representation of the original view | ||||
| entry | C | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. | ||||
| narrativeLink | 0..1 | url | narrativeLink to img src attribute URL: http://hl7.org/fhir/StructureDefinition/narrativeLink | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.identifier.use | required | IdentifierUse | ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | extensible | DocumentEntryTypeCode | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.attester:legalAuthenticator.mode | required | Fixed Value: legal | ||||
| Composition.section:originalRepresentation.code | example | Pattern: LOINC code 55108-5 |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:originalRepresentation | 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:originalRepresentation | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH Core Composition EPR | |||||
| 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 | 1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| informationRecipient | 0..* | Reference(CH Core Practitioner | CH Core Patient | RelatedPerson | CH Core Organization) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-informationrecipient | |||||
| dataEnterer | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | Version-independent identifier for the Composition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of composition Binding: DocumentEntry.typeCode (extensible) | ||||
| category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject | Σ | 1..1 | Reference(CH Core Patient EPR) | Who and/or what the composition is about | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter | Σ | 0..1 | Reference(CH Core Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | Σ | 1..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the composition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| time | 0..1 | dateTime | Timestamp of the authorship/data input URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-time | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| title | Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 1..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| confidentialityCode | 1..1 | CodeableConcept | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-confidentialitycode Binding: DocumentEntry.confidentialityCode (extensible) | |||||
| value | 0..1 | string | Primitive value for code | |||||
| Slices for attester | 0..* | BackboneElement | Attests to accuracy of composition Slice: Unordered, Open by value:mode | |||||
| attester:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Who attested the composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| attester:legalAuthenticator | 0..1 | BackboneElement | legal authenticator | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. Fixed Value: legal | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 1..1 | Reference(CH Core Patient EPR | RelatedPerson | CH Core Practitioner EPR | CH Core PractitionerRole EPR) | Who attested the composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| custodian | Σ | 0..1 | Reference(CH Core Organization EPR) | Organization which maintains the composition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| relatesTo | 0..* | BackboneElement | Relationships to other compositions/documents | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target[x] | 1..1 | Target of the relationship | ||||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(CH Core Composition EPR) | |||||||
| event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| period | Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code | ||||
| section:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author | 0..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| section:originalRepresentation | C | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 1..1 | string | Original representation | |||||
| code | 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: 55108-5 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| author | 0..* | Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 1..1 | Narrative | Representation of the original view | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | C | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| narrativeLink | 0..1 | url | narrativeLink to img src attribute URL: http://hl7.org/fhir/StructureDefinition/narrativeLink | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.identifier.use | required | IdentifierUse | ||||
| Composition.identifier.type | extensible | Identifier Type Codes | ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | extensible | DocumentEntryTypeCode | ||||
| Composition.category | example | DocumentClassValueSet | ||||
| Composition.subject.type | extensible | ResourceType | ||||
| Composition.author.type | extensible | ResourceType | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.attester.party.type | extensible | ResourceType | ||||
| Composition.attester:legalAuthenticator.mode | required | Fixed Value: legal | ||||
| Composition.attester:legalAuthenticator.party.type | extensible | ResourceType | ||||
| Composition.custodian.type | extensible | ResourceType | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | ListMode | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:originalRepresentation.code | example | Pattern: LOINC code 55108-5 | ||||
| Composition.section:originalRepresentation.mode | required | ListMode | ||||
| Composition.section:originalRepresentation.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:originalRepresentation.entry.type | extensible | ResourceType | ||||
| Composition.section:originalRepresentation.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:originalRepresentation | 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:originalRepresentation | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CHCoreComposition
Summary
Mandatory: 8 elements (5 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CHCoreComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH Core Composition EPR | |
| language | 1..1 | code | Language of the resource content | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| informationRecipient | 0..* | Reference(CH Core Practitioner | CH Core Patient | RelatedPerson | CH Core Organization) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-informationrecipient | |
| dataEnterer | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer | |
| identifier | 1..1 | Identifier | Version-independent identifier for the Composition | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| value | 1..1 | string | The value that is unique | |
| type | 1..1 | CodeableConcept | Kind of composition Binding: DocumentEntry.typeCode (extensible) | |
| subject | 1..1 | Reference(CH Core Patient EPR) | Who and/or what the composition is about | |
| author | 1..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the composition | |
| time | 0..1 | dateTime | Timestamp of the authorship/data input URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-time | |
| confidentiality | 1..1 | code | As defined by affinity domain | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| confidentialityCode | 1..1 | CodeableConcept | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-confidentialitycode Binding: DocumentEntry.confidentialityCode (extensible) | |
| Slices for attester | 0..* | BackboneElement | Attests to accuracy of composition Slice: Unordered, Open by value:mode | |
| attester:legalAuthenticator | 0..1 | BackboneElement | legal authenticator | |
| mode | 1..1 | code | personal | professional | legal | official Fixed Value: legal | |
| party | 1..1 | Reference(CH Core Patient EPR | RelatedPerson | CH Core Practitioner EPR | CH Core PractitionerRole EPR) | Who attested the composition | |
| custodian | 0..1 | Reference(CH Core Organization EPR) | Organization which maintains the composition | |
| relatesTo | ||||
| target[x] | 1..1 | Target of the relationship | ||
| targetIdentifier | Identifier | |||
| targetReference | Reference(CH Core Composition EPR) | |||
| Slices for section | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code | |
| section:All Slices | Content/Rules for all slices | |||
| author | 0..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the section | |
| section:originalRepresentation | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. | |
| title | 1..1 | string | Original representation | |
| 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: 55108-5 | |
| text | 1..1 | Narrative | Representation of the original view | |
| entry | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. | |
| narrativeLink | 0..1 | url | narrativeLink to img src attribute URL: http://hl7.org/fhir/StructureDefinition/narrativeLink | |
| section | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Composition.type | extensible | DocumentEntryTypeCode |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH Core Composition EPR | |||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| informationRecipient | 0..* | Reference(CH Core Practitioner | CH Core Patient | RelatedPerson | CH Core Organization) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-informationrecipient | |||||
| dataEnterer | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | Version-independent identifier for the Composition | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of composition Binding: DocumentEntry.typeCode (extensible) | ||||
| subject | Σ | 1..1 | Reference(CH Core Patient EPR) | Who and/or what the composition is about | ||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | Σ | 1..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the composition | ||||
| time | 0..1 | dateTime | Timestamp of the authorship/data input URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-time | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| title | Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 1..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| confidentialityCode | 1..1 | CodeableConcept | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-confidentialitycode Binding: DocumentEntry.confidentialityCode (extensible) | |||||
| Slices for attester | 0..* | BackboneElement | Attests to accuracy of composition Slice: Unordered, Open by value:mode | |||||
| attester:All Slices | Content/Rules for all slices | |||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| attester:legalAuthenticator | 0..1 | BackboneElement | legal authenticator | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. Fixed Value: legal | |||||
| party | 1..1 | Reference(CH Core Patient EPR | RelatedPerson | CH Core Practitioner EPR | CH Core PractitionerRole EPR) | Who attested the composition | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| custodian | Σ | 0..1 | Reference(CH Core Organization EPR) | Organization which maintains the composition | ||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code | ||||
| section:All Slices | Content/Rules for all slices | |||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| author | 0..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the section | |||||
| section:originalRepresentation | C | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 1..1 | string | Original representation | |||||
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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: 55108-5 | |||||
| text | C | 1..1 | Narrative | Representation of the original view | ||||
| entry | C | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. | ||||
| narrativeLink | 0..1 | url | narrativeLink to img src attribute URL: http://hl7.org/fhir/StructureDefinition/narrativeLink | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.identifier.use | required | IdentifierUse | ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | extensible | DocumentEntryTypeCode | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.attester:legalAuthenticator.mode | required | Fixed Value: legal | ||||
| Composition.section:originalRepresentation.code | example | Pattern: LOINC code 55108-5 |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:originalRepresentation | 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:originalRepresentation | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH Core Composition EPR | |||||
| 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 | 1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| informationRecipient | 0..* | Reference(CH Core Practitioner | CH Core Patient | RelatedPerson | CH Core Organization) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-informationrecipient | |||||
| dataEnterer | 0..1 | (Complex) | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | Version-independent identifier for the Composition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of composition Binding: DocumentEntry.typeCode (extensible) | ||||
| category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject | Σ | 1..1 | Reference(CH Core Patient EPR) | Who and/or what the composition is about | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter | Σ | 0..1 | Reference(CH Core Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | Σ | 1..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the composition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| time | 0..1 | dateTime | Timestamp of the authorship/data input URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-time | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| title | Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 1..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| confidentialityCode | 1..1 | CodeableConcept | Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-confidentialitycode Binding: DocumentEntry.confidentialityCode (extensible) | |||||
| value | 0..1 | string | Primitive value for code | |||||
| Slices for attester | 0..* | BackboneElement | Attests to accuracy of composition Slice: Unordered, Open by value:mode | |||||
| attester:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Who attested the composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| attester:legalAuthenticator | 0..1 | BackboneElement | legal authenticator | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. Fixed Value: legal | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 1..1 | Reference(CH Core Patient EPR | RelatedPerson | CH Core Practitioner EPR | CH Core PractitionerRole EPR) | Who attested the composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| custodian | Σ | 0..1 | Reference(CH Core Organization EPR) | Organization which maintains the composition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| relatesTo | 0..* | BackboneElement | Relationships to other compositions/documents | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target[x] | 1..1 | Target of the relationship | ||||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(CH Core Composition EPR) | |||||||
| event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| period | Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code | ||||
| section:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author | 0..* | Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson | CH Core Organization EPR) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| section:originalRepresentation | C | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 1..1 | string | Original representation | |||||
| code | 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: 55108-5 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| author | 0..* | Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 1..1 | Narrative | Representation of the original view | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | C | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| narrativeLink | 0..1 | url | narrativeLink to img src attribute URL: http://hl7.org/fhir/StructureDefinition/narrativeLink | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.identifier.use | required | IdentifierUse | ||||
| Composition.identifier.type | extensible | Identifier Type Codes | ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | extensible | DocumentEntryTypeCode | ||||
| Composition.category | example | DocumentClassValueSet | ||||
| Composition.subject.type | extensible | ResourceType | ||||
| Composition.author.type | extensible | ResourceType | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.attester.party.type | extensible | ResourceType | ||||
| Composition.attester:legalAuthenticator.mode | required | Fixed Value: legal | ||||
| Composition.attester:legalAuthenticator.party.type | extensible | ResourceType | ||||
| Composition.custodian.type | extensible | ResourceType | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | ListMode | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:originalRepresentation.code | example | Pattern: LOINC code 55108-5 | ||||
| Composition.section:originalRepresentation.mode | required | ListMode | ||||
| Composition.section:originalRepresentation.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:originalRepresentation.entry.type | extensible | ResourceType | ||||
| Composition.section:originalRepresentation.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:originalRepresentation | 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:originalRepresentation | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CHCoreComposition
Summary
Mandatory: 8 elements (5 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron