CH EMED (R4)
5.0.0-ci-build - ci-build
CH EMED (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-emed/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-composition-pharmaceuticaladvice | Version: 5.0.0-ci-build | |||
Active as of 2024-11-15 | Computable Name: CHEMEDCompositionPharmaceuticalAdvice | |||
Copyright/Legal: CC0-1.0 |
Definition of the composition for the pharmaceutical advice document
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHCoreCompositionEPR
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | CHCoreCompositionEPR | CH EMED Pharmaceutical Advice Composition | |
language | 1..1 | code | Language of the document | |
identifier | ||||
value | 1..1 | string | The value that is unique Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | |
status | 1..1 | code | preliminary | final | amended | entered-in-error Fixed Value: final | |
type | C | 1..1 | CodeableConcept | Record artifact (record artifact) ch-emed-comp-padv: If a LOINC code is additionally provided, '61356-2' shall be used for this document type. 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://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 419891008 | |
subject | 1..1 | Reference(CH Core Patient EPR) | A patient for whom this document instance was created | |
date | 1..1 | dateTime | The document's creation date and time | |
Slices for 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 Slice: Unordered, Closed by profile:resolve() | |
author:person | 1..* | Reference(CH EMED PractitionerRole | CH Core Patient EPR | RelatedPerson) | The author of the document (person) | |
author:device | 0..* | Reference(Device) | The device that created the document | |
title | 1..1 | string | 'Kommentar zur Medikation' in german or 'Commentaire relatif à la médication' in french or 'Commento sulla terapia farmacologica' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | |
confidentiality | ||||
Slices for extension | Content/Rules for all slices | |||
extension:confidentialityCode | 1..1 | EPRConfidentialityCode | Swiss realm of confidentiality code according to the Swiss EPR regulation | |
attester | 0..* | BackboneElement | The authenticator of the document (person) | |
Slices for attester | Content/Rules for all slices | |||
attester:legalAuthenticator | 0..1 | BackboneElement | The legal authenticator of the document (person) | |
time | 0..1 | dateTime | Timestamp of the signature | |
section | 1..* | BackboneElement | Composition is broken into sections | |
Slices for section | Content/Rules for all slices | |||
section:pharmaceuticalAdvice | 1..1 | BackboneElement | Pharmaceutical advice | |
title | 1..1 | string | 'Hinweise zur Medikation' in german or 'Conseils sur les médicaments' in french or 'Consigli sui medicamenti' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | |
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: 61357-0 | |
text | 1..1 | Narrative | Human readable text of this section | |
entry | 1..1 | Reference(CH EMED Observation (PADV)) | Observation | |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
section | 0..0 | |||
section:annotation | 0..1 | BackboneElement | Annotation | |
title | 1..1 | string | 'Kommentar' in german or 'Commentaire' in french or 'Osservazione' in italian or 'Comment' in english or titles in other languages are also allowed | |
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: 48767-8 | |
text | 1..1 | Narrative | Human readable text of this section | |
section | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ch-emed-comp-padv | error | Composition.type | If a LOINC code is additionally provided, '61356-2' shall be used for this document type. : coding.exists(system = 'http://loinc.org') and (coding.exists(system = 'http://loinc.org' and code = '61356-2')) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | CHCoreCompositionEPR | CH EMED Pharmaceutical Advice Composition | |||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 1..1 | code | Language of the document Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for extension | Content/Rules for all slices | |||||||
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 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | ||||
status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Fixed Value: final | ||||
type | ΣC | 1..1 | CodeableConcept | Record artifact (record artifact) Binding: DocumentEntry.typeCode (extensible) ch-emed-comp-padv: If a LOINC code is additionally provided, '61356-2' shall be used for this document type. 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://snomed.info/sct | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 419891008 | |||||
subject | Σ | 1..1 | Reference(CH Core Patient EPR) | A patient for whom this document instance was created | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
date | Σ | 1..1 | dateTime | The document's creation date and time | ||||
Slices for 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 Slice: Unordered, Closed by profile:resolve() | ||||
author:All Slices | Content/Rules for all slices | |||||||
Slices for extension | Content/Rules for all slices | |||||||
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 | ||||
author:person | Σ | 1..* | Reference(CH EMED PractitionerRole | CH Core Patient EPR | RelatedPerson) | The author of the document (person) | ||||
Slices for extension | Content/Rules for all slices | |||||||
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 | ||||
author:device | Σ | 0..* | Reference(Device) | The device that created the document | ||||
Slices for extension | Content/Rules for all slices | |||||||
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 | 'Kommentar zur Medikation' in german or 'Commentaire relatif à la médication' in french or 'Commento sulla terapia farmacologica' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | ||||
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 | Swiss realm of confidentiality code according to the Swiss EPR regulation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-confidentialitycode Binding: DocumentEntry.confidentialityCode (extensible) | |||||
Slices for attester | 0..* | BackboneElement | The authenticator of the document (person) 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 | The legal authenticator of the document (person) | |||||
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 | Timestamp of the signature | |||||
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 | ||||
Slices for section | C | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
section:All Slices | Content/Rules for all slices | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
section:originalRepresentation | C | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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. | ||||
section:pharmaceuticalAdvice | C | 1..1 | BackboneElement | Pharmaceutical advice cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | 1..1 | string | 'Hinweise zur Medikation' in german or 'Conseils sur les médicaments' in french or 'Consigli sui medicamenti' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | |||||
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: 61357-0 | |||||
text | C | 1..1 | Narrative | Human readable text of this section | ||||
entry | C | 1..1 | Reference(CH EMED Observation (PADV)) | Observation | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
section:annotation | C | 0..1 | BackboneElement | Annotation cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | 1..1 | string | 'Kommentar' in german or 'Commentaire' in french or 'Osservazione' in italian or 'Comment' in english or titles in other languages are also allowed | |||||
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: 48767-8 | |||||
text | C | 1..1 | Narrative | Human readable text of this section | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Composition.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | Pattern: SNOMED-CT Code 419891008http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.attester:legalAuthenticator.mode | required | Fixed Value: legalhttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:originalRepresentation.code | example | Pattern: LOINC Code 55108-5http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.code | example | Pattern: LOINC Code 61357-0http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:annotation.code | example | Pattern: LOINC Code 48767-8http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-emed-comp-padv | error | Composition.type | If a LOINC code is additionally provided, '61356-2' shall be used for this document type. : coding.exists(system = 'http://loinc.org') and (coding.exists(system = 'http://loinc.org' and code = '61356-2')) | |
cmp-1 | error | Composition.section, Composition.section:originalRepresentation, Composition.section:pharmaceuticalAdvice, Composition.section:annotation | 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, Composition.section:pharmaceuticalAdvice, Composition.section:annotation | 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..* | CHCoreCompositionEPR | CH EMED Pharmaceutical Advice Composition | |||||
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 document 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 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | ||||
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. Fixed Value: final | ||||
type | ΣC | 1..1 | CodeableConcept | Record artifact (record artifact) Binding: DocumentEntry.typeCode (extensible) ch-emed-comp-padv: If a LOINC code is additionally provided, '61356-2' shall be used for this document type. 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://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 419891008 | |||||
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 | |||||
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) | A patient for whom this document instance was created | ||||
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 | The document's creation date and time | ||||
Slices for 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 Slice: Unordered, Closed by profile:resolve() | ||||
author:All Slices | Content/Rules for all slices | |||||||
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 | ||||
author:person | Σ | 1..* | Reference(CH EMED PractitionerRole | CH Core Patient EPR | RelatedPerson) | The author of the document (person) | ||||
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 | ||||
author:device | Σ | 0..* | Reference(Device) | The device that created the document | ||||
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 | 'Kommentar zur Medikation' in german or 'Commentaire relatif à la médication' in french or 'Commento sulla terapia farmacologica' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | ||||
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 | Swiss realm of confidentiality code according to the Swiss EPR regulation 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 | The authenticator of the document (person) 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 | The legal authenticator of the document (person) | |||||
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 | Timestamp of the signature | |||||
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 | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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. cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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. | ||||
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
section:pharmaceuticalAdvice | C | 1..1 | BackboneElement | Pharmaceutical advice cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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 | 'Hinweise zur Medikation' in german or 'Conseils sur les médicaments' in french or 'Consigli sui medicamenti' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | |||||
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: 61357-0 | |||||
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 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 | 1..1 | Narrative | Human readable text of this section | ||||
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(CH EMED Observation (PADV)) | Observation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
section:annotation | C | 0..1 | BackboneElement | Annotation cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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 | 'Kommentar' in german or 'Commentaire' in french or 'Osservazione' in italian or 'Comment' in english or titles in other languages are also allowed | |||||
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: 48767-8 | |||||
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 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 | 1..1 | Narrative | Human readable text of this section | ||||
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. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Composition.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Composition.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | Pattern: SNOMED-CT Code 419891008http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode | ||||
Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
Composition.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.author.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.author:person.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.author:device.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.attester.party.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.attester:legalAuthenticator.mode | required | Fixed Value: legalhttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.attester:legalAuthenticator.party.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.custodian.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | ||||
Composition.section:originalRepresentation.code | example | Pattern: LOINC Code 55108-5http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:originalRepresentation.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:originalRepresentation.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:originalRepresentation.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.code | example | Pattern: LOINC Code 61357-0http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.entry.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | ||||
Composition.section:annotation.code | example | Pattern: LOINC Code 48767-8http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:annotation.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:annotation.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:annotation.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-emed-comp-padv | error | Composition.type | If a LOINC code is additionally provided, '61356-2' shall be used for this document type. : coding.exists(system = 'http://loinc.org') and (coding.exists(system = 'http://loinc.org' and code = '61356-2')) | |
cmp-1 | error | Composition.section, Composition.section:originalRepresentation, Composition.section:pharmaceuticalAdvice, Composition.section:annotation | 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, Composition.section:pharmaceuticalAdvice, Composition.section:annotation | 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 CHCoreCompositionEPR
Summary
Mandatory: 8 elements(3 nested mandatory elements)
Fixed: 1 element
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CHCoreCompositionEPR
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | CHCoreCompositionEPR | CH EMED Pharmaceutical Advice Composition | |
language | 1..1 | code | Language of the document | |
identifier | ||||
value | 1..1 | string | The value that is unique Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | |
status | 1..1 | code | preliminary | final | amended | entered-in-error Fixed Value: final | |
type | C | 1..1 | CodeableConcept | Record artifact (record artifact) ch-emed-comp-padv: If a LOINC code is additionally provided, '61356-2' shall be used for this document type. 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://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 419891008 | |
subject | 1..1 | Reference(CH Core Patient EPR) | A patient for whom this document instance was created | |
date | 1..1 | dateTime | The document's creation date and time | |
Slices for 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 Slice: Unordered, Closed by profile:resolve() | |
author:person | 1..* | Reference(CH EMED PractitionerRole | CH Core Patient EPR | RelatedPerson) | The author of the document (person) | |
author:device | 0..* | Reference(Device) | The device that created the document | |
title | 1..1 | string | 'Kommentar zur Medikation' in german or 'Commentaire relatif à la médication' in french or 'Commento sulla terapia farmacologica' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | |
confidentiality | ||||
Slices for extension | Content/Rules for all slices | |||
extension:confidentialityCode | 1..1 | EPRConfidentialityCode | Swiss realm of confidentiality code according to the Swiss EPR regulation | |
attester | 0..* | BackboneElement | The authenticator of the document (person) | |
Slices for attester | Content/Rules for all slices | |||
attester:legalAuthenticator | 0..1 | BackboneElement | The legal authenticator of the document (person) | |
time | 0..1 | dateTime | Timestamp of the signature | |
section | 1..* | BackboneElement | Composition is broken into sections | |
Slices for section | Content/Rules for all slices | |||
section:pharmaceuticalAdvice | 1..1 | BackboneElement | Pharmaceutical advice | |
title | 1..1 | string | 'Hinweise zur Medikation' in german or 'Conseils sur les médicaments' in french or 'Consigli sui medicamenti' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | |
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: 61357-0 | |
text | 1..1 | Narrative | Human readable text of this section | |
entry | 1..1 | Reference(CH EMED Observation (PADV)) | Observation | |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
section | 0..0 | |||
section:annotation | 0..1 | BackboneElement | Annotation | |
title | 1..1 | string | 'Kommentar' in german or 'Commentaire' in french or 'Osservazione' in italian or 'Comment' in english or titles in other languages are also allowed | |
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: 48767-8 | |
text | 1..1 | Narrative | Human readable text of this section | |
section | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ch-emed-comp-padv | error | Composition.type | If a LOINC code is additionally provided, '61356-2' shall be used for this document type. : coding.exists(system = 'http://loinc.org') and (coding.exists(system = 'http://loinc.org' and code = '61356-2')) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | CHCoreCompositionEPR | CH EMED Pharmaceutical Advice Composition | |||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 1..1 | code | Language of the document Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for extension | Content/Rules for all slices | |||||||
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 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | ||||
status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Fixed Value: final | ||||
type | ΣC | 1..1 | CodeableConcept | Record artifact (record artifact) Binding: DocumentEntry.typeCode (extensible) ch-emed-comp-padv: If a LOINC code is additionally provided, '61356-2' shall be used for this document type. 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://snomed.info/sct | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 419891008 | |||||
subject | Σ | 1..1 | Reference(CH Core Patient EPR) | A patient for whom this document instance was created | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
date | Σ | 1..1 | dateTime | The document's creation date and time | ||||
Slices for 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 Slice: Unordered, Closed by profile:resolve() | ||||
author:All Slices | Content/Rules for all slices | |||||||
Slices for extension | Content/Rules for all slices | |||||||
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 | ||||
author:person | Σ | 1..* | Reference(CH EMED PractitionerRole | CH Core Patient EPR | RelatedPerson) | The author of the document (person) | ||||
Slices for extension | Content/Rules for all slices | |||||||
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 | ||||
author:device | Σ | 0..* | Reference(Device) | The device that created the document | ||||
Slices for extension | Content/Rules for all slices | |||||||
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 | 'Kommentar zur Medikation' in german or 'Commentaire relatif à la médication' in french or 'Commento sulla terapia farmacologica' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | ||||
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 | Swiss realm of confidentiality code according to the Swiss EPR regulation URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-confidentialitycode Binding: DocumentEntry.confidentialityCode (extensible) | |||||
Slices for attester | 0..* | BackboneElement | The authenticator of the document (person) 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 | The legal authenticator of the document (person) | |||||
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 | Timestamp of the signature | |||||
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 | ||||
Slices for section | C | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
section:All Slices | Content/Rules for all slices | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
section:originalRepresentation | C | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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. | ||||
section:pharmaceuticalAdvice | C | 1..1 | BackboneElement | Pharmaceutical advice cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | 1..1 | string | 'Hinweise zur Medikation' in german or 'Conseils sur les médicaments' in french or 'Consigli sui medicamenti' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | |||||
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: 61357-0 | |||||
text | C | 1..1 | Narrative | Human readable text of this section | ||||
entry | C | 1..1 | Reference(CH EMED Observation (PADV)) | Observation | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
section:annotation | C | 0..1 | BackboneElement | Annotation cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | 1..1 | string | 'Kommentar' in german or 'Commentaire' in french or 'Osservazione' in italian or 'Comment' in english or titles in other languages are also allowed | |||||
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: 48767-8 | |||||
text | C | 1..1 | Narrative | Human readable text of this section | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Composition.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | Pattern: SNOMED-CT Code 419891008http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.attester:legalAuthenticator.mode | required | Fixed Value: legalhttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:originalRepresentation.code | example | Pattern: LOINC Code 55108-5http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.code | example | Pattern: LOINC Code 61357-0http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:annotation.code | example | Pattern: LOINC Code 48767-8http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-emed-comp-padv | error | Composition.type | If a LOINC code is additionally provided, '61356-2' shall be used for this document type. : coding.exists(system = 'http://loinc.org') and (coding.exists(system = 'http://loinc.org' and code = '61356-2')) | |
cmp-1 | error | Composition.section, Composition.section:originalRepresentation, Composition.section:pharmaceuticalAdvice, Composition.section:annotation | 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, Composition.section:pharmaceuticalAdvice, Composition.section:annotation | 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..* | CHCoreCompositionEPR | CH EMED Pharmaceutical Advice Composition | |||||
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 document 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 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | ||||
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. Fixed Value: final | ||||
type | ΣC | 1..1 | CodeableConcept | Record artifact (record artifact) Binding: DocumentEntry.typeCode (extensible) ch-emed-comp-padv: If a LOINC code is additionally provided, '61356-2' shall be used for this document type. 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://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 419891008 | |||||
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 | |||||
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) | A patient for whom this document instance was created | ||||
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 | The document's creation date and time | ||||
Slices for 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 Slice: Unordered, Closed by profile:resolve() | ||||
author:All Slices | Content/Rules for all slices | |||||||
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 | ||||
author:person | Σ | 1..* | Reference(CH EMED PractitionerRole | CH Core Patient EPR | RelatedPerson) | The author of the document (person) | ||||
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 | ||||
author:device | Σ | 0..* | Reference(Device) | The device that created the document | ||||
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 | 'Kommentar zur Medikation' in german or 'Commentaire relatif à la médication' in french or 'Commento sulla terapia farmacologica' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | ||||
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 | Swiss realm of confidentiality code according to the Swiss EPR regulation 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 | The authenticator of the document (person) 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 | The legal authenticator of the document (person) | |||||
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 | Timestamp of the signature | |||||
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 | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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. cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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. | ||||
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
section:pharmaceuticalAdvice | C | 1..1 | BackboneElement | Pharmaceutical advice cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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 | 'Hinweise zur Medikation' in german or 'Conseils sur les médicaments' in french or 'Consigli sui medicamenti' in italian or 'Pharmaceutical Advice' in english or titles in other languages are also allowed | |||||
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: 61357-0 | |||||
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 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 | 1..1 | Narrative | Human readable text of this section | ||||
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(CH EMED Observation (PADV)) | Observation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
section:annotation | C | 0..1 | BackboneElement | Annotation cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
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 | 'Kommentar' in german or 'Commentaire' in french or 'Osservazione' in italian or 'Comment' in english or titles in other languages are also allowed | |||||
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: 48767-8 | |||||
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 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 | 1..1 | Narrative | Human readable text of this section | ||||
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. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Composition.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Composition.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | Pattern: SNOMED-CT Code 419891008http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode | ||||
Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
Composition.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.author.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.author:person.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.author:device.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.attester.party.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.attester:legalAuthenticator.mode | required | Fixed Value: legalhttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.attester:legalAuthenticator.party.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.custodian.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | ||||
Composition.section:originalRepresentation.code | example | Pattern: LOINC Code 55108-5http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:originalRepresentation.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:originalRepresentation.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:originalRepresentation.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.code | example | Pattern: LOINC Code 61357-0http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.entry.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.section:pharmaceuticalAdvice.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | ||||
Composition.section:annotation.code | example | Pattern: LOINC Code 48767-8http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:annotation.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:annotation.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:annotation.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ch-emed-comp-padv | error | Composition.type | If a LOINC code is additionally provided, '61356-2' shall be used for this document type. : coding.exists(system = 'http://loinc.org') and (coding.exists(system = 'http://loinc.org' and code = '61356-2')) | |
cmp-1 | error | Composition.section, Composition.section:originalRepresentation, Composition.section:pharmaceuticalAdvice, Composition.section:annotation | 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, Composition.section:pharmaceuticalAdvice, Composition.section:annotation | 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 CHCoreCompositionEPR
Summary
Mandatory: 8 elements(3 nested mandatory elements)
Fixed: 1 element
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron