CH ELM (R4)
1.1.0 - trial-use
CH ELM (R4)
1.1.0 - trial-use
This page is part of the Observations of notifiable communicable infectious diseases (v1.1.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-composition | Version: 1.1.0 | |||
| Active as of 2024-01-31 | Computable Name: ChElmComposition | |||
Copyright/Legal: CC0-1.0 |
||||
This CH ELM base profile constrains the Composition resource for the purpose of laboratory test reports.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ChLabReportComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | 0..* | ChLabReportComposition | CH ELM Composition: Laboratory Report | |
  identifier | 1..1 | Identifier | Persistent, unique identifier for the diagnostic report (UUID) | |
  system | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
 value | C | 1..1 | string | The value that is unique ch-elm-doc-identifier: The identifier must be an UUID. Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f |
| status | 1..1 | code | preliminary | final | amended | entered-in-error Required Pattern: final | |
 subject | 1..1 | Reference(CH ELM Patient) | Who and/or what the composition is about | |
| author | 1..1 | Reference(CH ELM Organization: Author) | Who and/or what authored the composition | |
| section | 1..1 | BackboneElement | Composition is broken into sections | |
 section:lab-no-subsections | 1..1 | BackboneElement | Variant 1: EU Laboratory Report section with entries and no sub-sections | |
 title | 1..1 | string | Label for section (e.g. for ToC) | |
 code | 1..1 | ChElmCodeableConcept | Concept - reference to a terminology or just text Binding: CH ELM Lab Study Types (required) | |
 entry | 1..1 | Reference(CH ELM Observation Results: Laboratory) | A reference to data that supports this section | |
| section:lab-subsections | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.section:lab-no-subsections.code | required | ChElmLabStudyTypeshttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-typesfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ch-elm-doc-identifier | error | Composition.identifier.value | The identifier must be an UUID. : startsWith('urn:uuid:') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | C | 0..* | ChLabReportComposition | CH ELM Composition: Laboratory Report |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| basedOn-order-or-requisition | 0..* | Identifier, Reference(ServiceRequest) | Document Based On Order URL: http://fhir.ch/ig/ch-lab-report/StructureDefinition/composition-basedOn-order-or-requisition | |
 extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-lab-report/StructureDefinition/composition-basedOn-order-or-requisition" | |
  Slices for value[x] | 0..1 | Reference(ServiceRequest) | Value of extension Slice: Unordered, Closed by type:$this | |
  value[x]:valueReference | 0..1 | Reference(CH Lab ServiceRequest: Laboratory Order) | Value of extension | |
| information-recipient | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.eu/fhir/StructureDefinition/information-recipient" | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..1 | Identifier | Persistent, unique identifier for the diagnostic report (UUID) |
| 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 Required Pattern: urn:ietf:rfc:3986 |
| value | ΣC | 1..1 | string | The value that is unique ch-elm-doc-identifier: The identifier must be an UUID. Example General: 123456 Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| Slices for category | Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
 category:studyType | Σ | 0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Lab Study Types in Switzerland (required) |
| category:specialty | Σ | 0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful groups (e.g. liver test; minerals; glucose profiles) Binding: Laboratory Specialty (required) |
| subject | Σ | 1..1 | Reference(CH ELM Patient) | Who and/or what the composition is about |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..1 | Reference(CH ELM Organization: Author) | Who and/or what authored the composition |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| title | Σ | 1..1 | string | Human Readable name/title |
 Slices for section | C | 1..1 | BackboneElement | Composition is broken into sections Slice: Unordered, Open by exists:$this.section, exists:$this.entry |
 section:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | 1..1 | string | Label for section (e.g. for ToC) | |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |
 section:lab-no-subsections | C | 1..1 | BackboneElement | Variant 1: EU Laboratory Report section with entries and no sub-sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | 1..1 | string | Label for section (e.g. for ToC) | |
| code | 1..1 | ChElmCodeableConcept | Concept - reference to a terminology or just text Binding: CH ELM Lab Study Types (required) | |
| entry | C | 1..1 | Reference(CH ELM Observation Results: Laboratory) | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | |
| Composition.category:studyType | required | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types | |
| Composition.category:specialty | required | LabSpecialtyEuVshttp://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab | |
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | |
| Composition.section:lab-no-subsections.code | required | ChElmLabStudyTypeshttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-typesfrom this IG | |
| Composition.section:lab-subsections.section.code | preferred | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types |
| Id | Grade | Path(s) | Details | Requirements |
| ch-elm-doc-identifier | error | Composition.identifier.value | The identifier must be an UUID. : startsWith('urn:uuid:') | |
| ch-lab-comp1 | warning | Composition | The resource should be conform to the corresponding EU LAB profile : conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab') | |
| cmp-1 | error | Composition.section, Composition.section:lab-no-subsections | 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:lab-no-subsections | 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 | C | 0..* | ChLabReportComposition | CH ELM Composition: Laboratory Report | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: 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 | |||||
| basedOn-order-or-requisition | 0..* | Identifier, Reference(ServiceRequest) | Document Based On Order URL: http://fhir.ch/ig/ch-lab-report/StructureDefinition/composition-basedOn-order-or-requisition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-lab-report/StructureDefinition/composition-basedOn-order-or-requisition" | |||||
| Slices for value[x] | 0..1 | Reference(ServiceRequest) | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueReference | 0..1 | Reference(CH Lab ServiceRequest: Laboratory Order) | Value of extension | |||||
| information-recipient | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.eu/fhir/StructureDefinition/information-recipient" | |||||
| value[x] | 0..1 | Reference(CH Lab Practitioner | Device | CH Lab Patient | RelatedPerson | CH Lab PractitionerRole | CH Core Organization) | Value of extension | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | Persistent, unique identifier for the diagnostic report (UUID) | ||||
| 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 Required Pattern: urn:ietf:rfc:3986 | ||||
| value | ΣC | 1..1 | string | The value that is unique ch-elm-doc-identifier: The identifier must be an UUID. Example General: 123456 Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f | ||||
| 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. Required Pattern: final | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| Slices for category | Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| category:studyType | Σ | 0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Lab Study Types in Switzerland (required) | ||||
| category:specialty | Σ | 0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful groups (e.g. liver test; minerals; glucose profiles) Binding: Laboratory Specialty (required) | ||||
| subject | Σ | 1..1 | Reference(CH ELM Patient) | Who and/or what the composition is about | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter | Σ | 0..1 | Reference(CH Core Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | Σ | 1..1 | Reference(CH ELM Organization: Author) | Who and/or what authored 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 | ||||
| title | Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(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 | ||||
| custodian | Σ | 0..1 | Reference(CH Core Organization) | 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) | |||||||
| 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..1 | BackboneElement | Composition is broken into sections Slice: Unordered, Open by exists:$this.section, exists:$this.entry | ||||
| 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 | 1..1 | string | Label for section (e.g. for ToC) | |||||
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| 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 | 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:lab-no-subsections | C | 1..1 | BackboneElement | Variant 1: EU Laboratory Report section with entries and no sub-sections | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 1..1 | string | Label for section (e.g. for ToC) | |||||
| code | 1..1 | ChElmCodeableConcept | Concept - reference to a terminology or just text Binding: CH ELM Lab Study Types (required) | |||||
| 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 | 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 | 1..1 | Reference(CH ELM Observation Results: Laboratory) | 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/languagesfrom the FHIR Standard | ||||
| Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Composition.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.category:studyType | required | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types | ||||
| Composition.category:specialty | required | LabSpecialtyEuVshttp://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab | ||||
| Composition.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Composition.author.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.attester.party.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Composition.custodian.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from 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-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:lab-no-subsections.code | required | ChElmLabStudyTypeshttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-typesfrom this IG | ||||
| Composition.section:lab-no-subsections.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section:lab-no-subsections.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:lab-no-subsections.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:lab-subsections.code | preferred | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types | ||||
| Composition.section:lab-subsections.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section:lab-subsections.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:lab-subsections.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:lab-subsections.section.code | preferred | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types | ||||
| Composition.section:lab-subsections.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section:lab-subsections.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:lab-subsections.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-elm-doc-identifier | error | Composition.identifier.value | The identifier must be an UUID. : startsWith('urn:uuid:') | |
| ch-lab-comp1 | warning | Composition | The resource should be conform to the corresponding EU LAB profile : conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab') | |
| cmp-1 | error | Composition.section, Composition.section:lab-no-subsections | 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:lab-no-subsections | 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 ChLabReportComposition
Summary
Mandatory: 7 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ChLabReportComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | ChLabReportComposition | CH ELM Composition: Laboratory Report | |
| identifier | 1..1 | Identifier | Persistent, unique identifier for the diagnostic report (UUID) | |
| system | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
| value | C | 1..1 | string | The value that is unique ch-elm-doc-identifier: The identifier must be an UUID. Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f |
| status | 1..1 | code | preliminary | final | amended | entered-in-error Required Pattern: final | |
| subject | 1..1 | Reference(CH ELM Patient) | Who and/or what the composition is about | |
| author | 1..1 | Reference(CH ELM Organization: Author) | Who and/or what authored the composition | |
| section | 1..1 | BackboneElement | Composition is broken into sections | |
| section:lab-no-subsections | 1..1 | BackboneElement | Variant 1: EU Laboratory Report section with entries and no sub-sections | |
| title | 1..1 | string | Label for section (e.g. for ToC) | |
| code | 1..1 | ChElmCodeableConcept | Concept - reference to a terminology or just text Binding: CH ELM Lab Study Types (required) | |
| entry | 1..1 | Reference(CH ELM Observation Results: Laboratory) | A reference to data that supports this section | |
| section:lab-subsections | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.section:lab-no-subsections.code | required | ChElmLabStudyTypeshttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-typesfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ch-elm-doc-identifier | error | Composition.identifier.value | The identifier must be an UUID. : startsWith('urn:uuid:') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | C | 0..* | ChLabReportComposition | CH ELM Composition: Laboratory Report |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| basedOn-order-or-requisition | 0..* | Identifier, Reference(ServiceRequest) | Document Based On Order URL: http://fhir.ch/ig/ch-lab-report/StructureDefinition/composition-basedOn-order-or-requisition | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-lab-report/StructureDefinition/composition-basedOn-order-or-requisition" | |
| Slices for value[x] | 0..1 | Reference(ServiceRequest) | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueReference | 0..1 | Reference(CH Lab ServiceRequest: Laboratory Order) | Value of extension | |
| information-recipient | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.eu/fhir/StructureDefinition/information-recipient" | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..1 | Identifier | Persistent, unique identifier for the diagnostic report (UUID) |
| 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 Required Pattern: urn:ietf:rfc:3986 |
| value | ΣC | 1..1 | string | The value that is unique ch-elm-doc-identifier: The identifier must be an UUID. Example General: 123456 Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| Slices for category | Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
| category:studyType | Σ | 0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Lab Study Types in Switzerland (required) |
| category:specialty | Σ | 0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful groups (e.g. liver test; minerals; glucose profiles) Binding: Laboratory Specialty (required) |
| subject | Σ | 1..1 | Reference(CH ELM Patient) | Who and/or what the composition is about |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..1 | Reference(CH ELM Organization: Author) | Who and/or what authored the composition |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| title | Σ | 1..1 | string | Human Readable name/title |
| Slices for section | C | 1..1 | BackboneElement | Composition is broken into sections Slice: Unordered, Open by exists:$this.section, exists:$this.entry |
| section:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | 1..1 | string | Label for section (e.g. for ToC) | |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |
| section:lab-no-subsections | C | 1..1 | BackboneElement | Variant 1: EU Laboratory Report section with entries and no sub-sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | 1..1 | string | Label for section (e.g. for ToC) | |
| code | 1..1 | ChElmCodeableConcept | Concept - reference to a terminology or just text Binding: CH ELM Lab Study Types (required) | |
| entry | C | 1..1 | Reference(CH ELM Observation Results: Laboratory) | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | |
| Composition.category:studyType | required | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types | |
| Composition.category:specialty | required | LabSpecialtyEuVshttp://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab | |
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | |
| Composition.section:lab-no-subsections.code | required | ChElmLabStudyTypeshttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-typesfrom this IG | |
| Composition.section:lab-subsections.section.code | preferred | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types |
| Id | Grade | Path(s) | Details | Requirements |
| ch-elm-doc-identifier | error | Composition.identifier.value | The identifier must be an UUID. : startsWith('urn:uuid:') | |
| ch-lab-comp1 | warning | Composition | The resource should be conform to the corresponding EU LAB profile : conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab') | |
| cmp-1 | error | Composition.section, Composition.section:lab-no-subsections | 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:lab-no-subsections | 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 | C | 0..* | ChLabReportComposition | CH ELM Composition: Laboratory Report | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: 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 | |||||
| basedOn-order-or-requisition | 0..* | Identifier, Reference(ServiceRequest) | Document Based On Order URL: http://fhir.ch/ig/ch-lab-report/StructureDefinition/composition-basedOn-order-or-requisition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://fhir.ch/ig/ch-lab-report/StructureDefinition/composition-basedOn-order-or-requisition" | |||||
| Slices for value[x] | 0..1 | Reference(ServiceRequest) | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueReference | 0..1 | Reference(CH Lab ServiceRequest: Laboratory Order) | Value of extension | |||||
| information-recipient | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.eu/fhir/StructureDefinition/information-recipient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.eu/fhir/StructureDefinition/information-recipient" | |||||
| value[x] | 0..1 | Reference(CH Lab Practitioner | Device | CH Lab Patient | RelatedPerson | CH Lab PractitionerRole | CH Core Organization) | Value of extension | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | Persistent, unique identifier for the diagnostic report (UUID) | ||||
| 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 Required Pattern: urn:ietf:rfc:3986 | ||||
| value | ΣC | 1..1 | string | The value that is unique ch-elm-doc-identifier: The identifier must be an UUID. Example General: 123456 Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f | ||||
| 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. Required Pattern: final | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| Slices for category | Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| category:studyType | Σ | 0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Lab Study Types in Switzerland (required) | ||||
| category:specialty | Σ | 0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful groups (e.g. liver test; minerals; glucose profiles) Binding: Laboratory Specialty (required) | ||||
| subject | Σ | 1..1 | Reference(CH ELM Patient) | Who and/or what the composition is about | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter | Σ | 0..1 | Reference(CH Core Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | Σ | 1..1 | Reference(CH ELM Organization: Author) | Who and/or what authored 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 | ||||
| title | Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(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 | ||||
| custodian | Σ | 0..1 | Reference(CH Core Organization) | 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) | |||||||
| 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..1 | BackboneElement | Composition is broken into sections Slice: Unordered, Open by exists:$this.section, exists:$this.entry | ||||
| 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 | 1..1 | string | Label for section (e.g. for ToC) | |||||
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| 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 | 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:lab-no-subsections | C | 1..1 | BackboneElement | Variant 1: EU Laboratory Report section with entries and no sub-sections | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 1..1 | string | Label for section (e.g. for ToC) | |||||
| code | 1..1 | ChElmCodeableConcept | Concept - reference to a terminology or just text Binding: CH ELM Lab Study Types (required) | |||||
| 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 | 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 | 1..1 | Reference(CH ELM Observation Results: Laboratory) | 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/languagesfrom the FHIR Standard | ||||
| Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Composition.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.category:studyType | required | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types | ||||
| Composition.category:specialty | required | LabSpecialtyEuVshttp://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab | ||||
| Composition.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Composition.author.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.attester.party.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Composition.custodian.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from 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-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:lab-no-subsections.code | required | ChElmLabStudyTypeshttp://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-typesfrom this IG | ||||
| Composition.section:lab-no-subsections.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section:lab-no-subsections.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:lab-no-subsections.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:lab-subsections.code | preferred | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types | ||||
| Composition.section:lab-subsections.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section:lab-subsections.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:lab-subsections.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:lab-subsections.section.code | preferred | LabStudyTypesEuVshttp://fhir.ch/ig/ch-lab-report/ValueSet/ch-lab-report-lab-study-types | ||||
| Composition.section:lab-subsections.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section:lab-subsections.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:lab-subsections.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-elm-doc-identifier | error | Composition.identifier.value | The identifier must be an UUID. : startsWith('urn:uuid:') | |
| ch-lab-comp1 | warning | Composition | The resource should be conform to the corresponding EU LAB profile : conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab') | |
| cmp-1 | error | Composition.section, Composition.section:lab-no-subsections | 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:lab-no-subsections | 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 ChLabReportComposition
Summary
Mandatory: 7 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ Federal Office of Public Health FOPH. Package ch.fhir.ig.ch-elm#1.1.0 based on FHIR 4.0.1. Generated 2024-01-31
Links: Table of Contents |
QA Report
| Propose a change