CH EPR mHealth (R4)
4.0.0-ci-build - DSTU3 Switzerland flag

CH EPR mHealth (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/qligier/ch-epr-mhealth/ and changes regularly. See the Directory of published versions

Resource Profile: CH MHD SubmissionSet Comprehensive

Official URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-submissionset-comprehensive Version: 4.0.0-ci-build
Draft as of 2021-04-15 Computable Name: CHMhdSubmissionSetComprehensive

Copyright/Legal: CC0-1.0

CH MHD SubmissionSet Comprehensive

Usage:

Formal Views of Profile Content

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

This structure is derived from SubmissionSetComprehensiveUnContained

NameFlagsCard.TypeDescription & Constraintsdoco
.. List SubmissionSetComprehensiveUnContained
... extension 3..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:designationType S 1..1 DesignationType Clinical code of the List
Binding: SubmissionSet.contentTypeCode (required)
.... extension:sourceId S 1..1 SourceId Publisher organization identity of the SubmissionSet
.... authorAuthorRole S 0..1 Coding The SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... identifier S 0..* Identifier identifier, for uniqueID set use to ususal
... mode S 1..1 code working | snapshot | changes
... code S 1..1 CodeableConcept What the purpose of this list is
... subject S 1..1 Reference(CH Core Patient) {r} If all resources have the same subject
... date S 1..1 dateTime When the list was prepared
... source S 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... Slices for extension Content/Rules for all slices
..... extension:authorOrg 0..0
... entry S 1..* BackboneElement Entries in the list
.... item S 1..1 Reference(CH MHD DocumentReference Comprehensive) {r, b} Actual entry

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
List.extension:designationTyperequiredSubmissionSetContentTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/SubmissionSet.contentTypeCode
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* SubmissionSetComprehensiveUnContained A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... designationType S 1..1 CodeableConcept Clinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
.... sourceId S 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
.... authorAuthorRole S 0..1 Coding The SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... Slices for identifier S 0..* Identifier identifier, for uniqueID set use to ususal
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... mode ?!SΣ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
... code SΣ 1..1 CodeableConcept What the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
... subject SΣ 1..1 Reference(CH Core Patient) {r} If all resources have the same subject
... date SΣ 1..1 dateTime When the list was prepared
... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... Slices for extension Content/Rules for all slices
... note 0..1 Annotation Comments about the list
... entry SC 1..* BackboneElement Entries in the list
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item S 1..1 Reference(CH MHD DocumentReference Comprehensive) {r, b} Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.coderequiredPattern: submissionset
https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA 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()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* SubmissionSetComprehensiveUnContained A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... designationType S 1..1 CodeableConcept Clinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
.... sourceId S 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
.... authorAuthorRole S 0..1 Coding The SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... Slices for identifier S 0..* Identifier identifier, for uniqueID set use to ususal
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... mode ?!SΣ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code SΣ 1..1 CodeableConcept What the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(CH Core Patient) {r} If all resources have the same subject
... date SΣ 1..1 dateTime When the list was prepared
... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..1 Annotation Comments about the list
... entry SC 1..* BackboneElement Entries in the list
.... 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
.... item S 1..1 Reference(CH MHD DocumentReference Comprehensive) {r, b} Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
List.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.coderequiredPattern: submissionset
https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS
List.source.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA 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()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()

This structure is derived from SubmissionSetComprehensiveUnContained

Differential View

This structure is derived from SubmissionSetComprehensiveUnContained

NameFlagsCard.TypeDescription & Constraintsdoco
.. List SubmissionSetComprehensiveUnContained
... extension 3..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:designationType S 1..1 DesignationType Clinical code of the List
Binding: SubmissionSet.contentTypeCode (required)
.... extension:sourceId S 1..1 SourceId Publisher organization identity of the SubmissionSet
.... authorAuthorRole S 0..1 Coding The SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... identifier S 0..* Identifier identifier, for uniqueID set use to ususal
... mode S 1..1 code working | snapshot | changes
... code S 1..1 CodeableConcept What the purpose of this list is
... subject S 1..1 Reference(CH Core Patient) {r} If all resources have the same subject
... date S 1..1 dateTime When the list was prepared
... source S 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... Slices for extension Content/Rules for all slices
..... extension:authorOrg 0..0
... entry S 1..* BackboneElement Entries in the list
.... item S 1..1 Reference(CH MHD DocumentReference Comprehensive) {r, b} Actual entry

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
List.extension:designationTyperequiredSubmissionSetContentTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/SubmissionSet.contentTypeCode

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* SubmissionSetComprehensiveUnContained A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... designationType S 1..1 CodeableConcept Clinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
.... sourceId S 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
.... authorAuthorRole S 0..1 Coding The SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... Slices for identifier S 0..* Identifier identifier, for uniqueID set use to ususal
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... mode ?!SΣ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
... code SΣ 1..1 CodeableConcept What the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
... subject SΣ 1..1 Reference(CH Core Patient) {r} If all resources have the same subject
... date SΣ 1..1 dateTime When the list was prepared
... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... Slices for extension Content/Rules for all slices
... note 0..1 Annotation Comments about the list
... entry SC 1..* BackboneElement Entries in the list
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item S 1..1 Reference(CH MHD DocumentReference Comprehensive) {r, b} Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.coderequiredPattern: submissionset
https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA 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()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* SubmissionSetComprehensiveUnContained A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... designationType S 1..1 CodeableConcept Clinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
.... sourceId S 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
.... authorAuthorRole S 0..1 Coding The SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... Slices for identifier S 0..* Identifier identifier, for uniqueID set use to ususal
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... mode ?!SΣ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code SΣ 1..1 CodeableConcept What the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(CH Core Patient) {r} If all resources have the same subject
... date SΣ 1..1 dateTime When the list was prepared
... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..1 Annotation Comments about the list
... entry SC 1..* BackboneElement Entries in the list
.... 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
.... item S 1..1 Reference(CH MHD DocumentReference Comprehensive) {r, b} Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
List.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.coderequiredPattern: submissionset
https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS
List.source.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA 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()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()

This structure is derived from SubmissionSetComprehensiveUnContained

Summary

Mandatory: 2 elements
Must-Support: 12 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron