CH LAB-Order (R4)
2.0.0 - ci-build Switzerland flag

CH LAB-Order (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-lab-order/ and changes regularly. See the Directory of published versions

Resource Profile: CH LAB-Order Composition with Service Request

Official URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-order-composition-with-sr Version: 2.0.0
Draft as of 2019-01-30 Computable Name: ChLabOrderCompositionWithSR

Copyright/Legal: CC0-1.0

Definition for Composition resource in the context of CH LAB-Order with Service Request, parent is CHCoreComposition

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CHCoreComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CHCoreCompositionCH LAB-Order Composition with ServiceRequest
... type 1..1CodeableConceptPrecise type of clinical document
Binding: DocumentEntry.typeCode (required)
... category 1..1CodeableConceptOrder Document
Binding: DocumentEntry.classCode (required)
... subject S1..1Reference(CH Core Patient)Patient as the principle target of service request
... title S1..1stringMeaningful title
... Slices for section S1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by pattern:code
.... section:orderReferral S1..1BackboneElementContains the data that supports the order by ServiceRequest.
..... title S1..1stringLaboratory Order by Service Request
..... code S1..1CodeableConceptClassification of section (recommended)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 721963009
....... display1..1stringRepresentation defined by the system
Fixed Value: Order (record artifact)
..... text S0..1NarrativeText summary of the section, for human interpretation
..... Slices for entry S1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest S1..*Reference(CH LAB-Order-SR Single-test | CH LAB-Order-SR Container)ServiceRequest
....... reference S1..1stringLiteral reference, Relative, internal or absolute URL
...... entry:DocumentReference S0..*Reference(CH Core DocumentReference)DocumentReference
....... reference S1..1stringLiteral reference, Relative, internal or absolute URL
..... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Composition.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
from this IG
Composition.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CHCoreCompositionCH LAB-Order Composition with ServiceRequest
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... category Σ1..1CodeableConceptOrder Document
Binding: DocumentEntry.classCode (required)
... subject SΣ1..1Reference(CH Core Patient)Patient as the principle target of service request
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... date Σ1..1dateTimeComposition editing time
... author SΣ1..1Reference(CH Core PractitionerRole)The person/organization responsible for the form content
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... title SΣ1..1stringMeaningful title
... Slices for section SC1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by pattern:code
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... section:orderReferral SC1..1BackboneElementContains the data that supports the order by ServiceRequest.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title S1..1stringLaboratory Order by Service Request
..... code S1..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 721963009
....... display1..1stringRepresentation defined by the system
Fixed Value: Order (record artifact)
..... text SC0..1NarrativeText summary of the section, for human interpretation
..... Slices for entry SC1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest SC1..*Reference(CH LAB-Order-SR Single-test | CH LAB-Order-SR Container)ServiceRequest
....... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
...... entry:DocumentReference SC0..*Reference(CH Core DocumentReference)DocumentReference
....... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
from this IG
Composition.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
from this IG
Composition.section:orderReferral.codeexamplePattern: SNOMED CT code 721963009("Order (record artifact)")
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:orderReferralA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:orderReferralA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CHCoreCompositionCH LAB-Order Composition with ServiceRequest
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type Σ1..1CodeableConceptPrecise type of clinical document
Binding: DocumentEntry.typeCode (required)
... category Σ1..1CodeableConceptOrder Document
Binding: DocumentEntry.classCode (required)
... subject SΣ1..1Reference(CH Core Patient)Patient as the principle target of service request
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter Σ0..1Reference(CH Core Encounter)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author SΣ1..1Reference(CH Core PractitionerRole)The person/organization responsible for the form content
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... title SΣ1..1stringMeaningful title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.

... attester 0..*BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who attested the composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... custodian Σ0..1Reference(CH Core Organization)Organization which maintains the composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(CH Core Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(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..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... Slices for section SC1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by pattern:code
.... section:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code 0..1CodeableConceptClassification 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..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... entry C0..*Reference(Resource)A reference to data that supports this section
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section
.... section:orderReferral SC1..1BackboneElementContains the data that supports the order by ServiceRequest.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title S1..1stringLaboratory Order by Service Request
..... code S1..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 721963009
....... display1..1stringRepresentation defined by the system
Fixed Value: Order (record artifact)
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain 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..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text SC0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... Slices for entry SC1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest SC1..*Reference(CH LAB-Order-SR Single-test | CH LAB-Order-SR Container)ServiceRequest
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... entry:DocumentReference SC0..*Reference(CH Core DocumentReference)DocumentReference
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
from this IG
Composition.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
from this IG
Composition.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.attester.party.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.custodian.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:orderReferral.codeexamplePattern: SNOMED CT code 721963009("Order (record artifact)")
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:orderReferral.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:orderReferral.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:orderReferral.entry:ServiceRequest.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.section:orderReferral.entry:DocumentReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.section:orderReferral.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:orderReferralA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:orderReferralA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CHCoreComposition

Summary

Mandatory: 9 elements (1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Composition.section is sliced based on the value of pattern:code
  • The element Composition.section.entry is sliced based on the value of profile:resolve()

Differential View

This structure is derived from CHCoreComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CHCoreCompositionCH LAB-Order Composition with ServiceRequest
... type 1..1CodeableConceptPrecise type of clinical document
Binding: DocumentEntry.typeCode (required)
... category 1..1CodeableConceptOrder Document
Binding: DocumentEntry.classCode (required)
... subject S1..1Reference(CH Core Patient)Patient as the principle target of service request
... title S1..1stringMeaningful title
... Slices for section S1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by pattern:code
.... section:orderReferral S1..1BackboneElementContains the data that supports the order by ServiceRequest.
..... title S1..1stringLaboratory Order by Service Request
..... code S1..1CodeableConceptClassification of section (recommended)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 721963009
....... display1..1stringRepresentation defined by the system
Fixed Value: Order (record artifact)
..... text S0..1NarrativeText summary of the section, for human interpretation
..... Slices for entry S1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest S1..*Reference(CH LAB-Order-SR Single-test | CH LAB-Order-SR Container)ServiceRequest
....... reference S1..1stringLiteral reference, Relative, internal or absolute URL
...... entry:DocumentReference S0..*Reference(CH Core DocumentReference)DocumentReference
....... reference S1..1stringLiteral reference, Relative, internal or absolute URL
..... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Composition.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
from this IG
Composition.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CHCoreCompositionCH LAB-Order Composition with ServiceRequest
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... category Σ1..1CodeableConceptOrder Document
Binding: DocumentEntry.classCode (required)
... subject SΣ1..1Reference(CH Core Patient)Patient as the principle target of service request
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... date Σ1..1dateTimeComposition editing time
... author SΣ1..1Reference(CH Core PractitionerRole)The person/organization responsible for the form content
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... title SΣ1..1stringMeaningful title
... Slices for section SC1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by pattern:code
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... section:orderReferral SC1..1BackboneElementContains the data that supports the order by ServiceRequest.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title S1..1stringLaboratory Order by Service Request
..... code S1..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 721963009
....... display1..1stringRepresentation defined by the system
Fixed Value: Order (record artifact)
..... text SC0..1NarrativeText summary of the section, for human interpretation
..... Slices for entry SC1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest SC1..*Reference(CH LAB-Order-SR Single-test | CH LAB-Order-SR Container)ServiceRequest
....... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
...... entry:DocumentReference SC0..*Reference(CH Core DocumentReference)DocumentReference
....... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
from this IG
Composition.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
from this IG
Composition.section:orderReferral.codeexamplePattern: SNOMED CT code 721963009("Order (record artifact)")
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:orderReferralA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:orderReferralA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CHCoreCompositionCH LAB-Order Composition with ServiceRequest
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type Σ1..1CodeableConceptPrecise type of clinical document
Binding: DocumentEntry.typeCode (required)
... category Σ1..1CodeableConceptOrder Document
Binding: DocumentEntry.classCode (required)
... subject SΣ1..1Reference(CH Core Patient)Patient as the principle target of service request
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter Σ0..1Reference(CH Core Encounter)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author SΣ1..1Reference(CH Core PractitionerRole)The person/organization responsible for the form content
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... title SΣ1..1stringMeaningful title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.

... attester 0..*BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who attested the composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... custodian Σ0..1Reference(CH Core Organization)Organization which maintains the composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(CH Core Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(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..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... Slices for section SC1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by pattern:code
.... section:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code 0..1CodeableConceptClassification 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..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... entry C0..*Reference(Resource)A reference to data that supports this section
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section
.... section:orderReferral SC1..1BackboneElementContains the data that supports the order by ServiceRequest.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title S1..1stringLaboratory Order by Service Request
..... code S1..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 721963009
....... display1..1stringRepresentation defined by the system
Fixed Value: Order (record artifact)
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain 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..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text SC0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... Slices for entry SC1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest SC1..*Reference(CH LAB-Order-SR Single-test | CH LAB-Order-SR Container)ServiceRequest
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... entry:DocumentReference SC0..*Reference(CH Core DocumentReference)DocumentReference
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
from this IG
Composition.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
from this IG
Composition.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.attester.party.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.custodian.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:orderReferral.codeexamplePattern: SNOMED CT code 721963009("Order (record artifact)")
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:orderReferral.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:orderReferral.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:orderReferral.entry:ServiceRequest.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.section:orderReferral.entry:DocumentReference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Composition.section:orderReferral.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:orderReferralA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:orderReferralA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CHCoreComposition

Summary

Mandatory: 9 elements (1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Composition.section is sliced based on the value of pattern:code
  • The element Composition.section.entry is sliced based on the value of profile:resolve()

 

Other representations of profile: CSV, Excel, Schematron