Mobile access to Health Documents (MHD)
5.0.0-prototype - ci-build International flag

Mobile access to Health Documents (MHD), published by IHE IT Infrastructure Technical Committee. This is not an authorized publication; it is the continuous build for version 5.0.0-prototype). This version is based on the current content of https://github.com/IHE/ITI.MHD/ and changes regularly. See the Directory of published versions

Resource Profile: MHD common List with designationType

Official URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.List Version: 5.0.0-prototype
Active as of 2022-07-22 Computable Name: MhdList

Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property

A profile on the List resource for MHD. Used with both Folder and SubmissionSet.

  • MHD adds a codeable Concept to List for use with Folder and SubmissionSet

Usage:

Formal Views of Profile Content

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

This structure is derived from List

Summary

Mandatory: 1 element (2 nested mandatory elements)
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element List.identifier is sliced based on the value of value:use

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*ListA list is a curated collection of resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designationType 0..*CodeableConceptClinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
... modifierExtension 0..0
... Slices for identifier 0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1IdentifieruniqueId
..... use 1..1codeusual | official | temp | secondary | old (If known)
Required Pattern: usual
.... identifier:entryUUID 0..*IdentifierentryUUID
..... use 1..1codeusual | official | temp | secondary | old (If known)
Required Pattern: official
... code 1..1CodeableConceptWhat the purpose of this list is
Binding: MHD List Types ValueSet (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListA list is a curated collection of resources
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designationType 0..*CodeableConceptClinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
... Slices for identifier 0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1IdentifieruniqueId
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:entryUUID 0..*IdentifierentryUUID
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.

... mode ?!Σ1..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code Σ1..1CodeableConceptWhat the purpose of this list is
Binding: MHD List Types ValueSet (required)
... subject Σ0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter 0..1Reference(Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.

... note 0..*AnnotationComments about the list
... entry I0..*BackboneElementEntries in the list
.... 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
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(Resource)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

This structure is derived from List

Summary

Mandatory: 1 element (2 nested mandatory elements)
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element List.identifier is sliced based on the value of value:use

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*ListA list is a curated collection of resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designationType 0..*CodeableConceptClinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
... modifierExtension 0..0
... Slices for identifier 0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1IdentifieruniqueId
..... use 1..1codeusual | official | temp | secondary | old (If known)
Required Pattern: usual
.... identifier:entryUUID 0..*IdentifierentryUUID
..... use 1..1codeusual | official | temp | secondary | old (If known)
Required Pattern: official
... code 1..1CodeableConceptWhat the purpose of this list is
Binding: MHD List Types ValueSet (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListA list is a curated collection of resources
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designationType 0..*CodeableConceptClinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
... Slices for identifier 0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1IdentifieruniqueId
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:entryUUID 0..*IdentifierentryUUID
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.

... mode ?!Σ1..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code Σ1..1CodeableConceptWhat the purpose of this list is
Binding: MHD List Types ValueSet (required)
... subject Σ0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter 0..1Reference(Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.

... note 0..*AnnotationComments about the list
... entry I0..*BackboneElementEntries in the list
.... 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
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(Resource)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
List.languagepreferredCommonLanguages
Max Binding: AllLanguages
List.identifier:uniqueId.userequiredPattern: usual
List.identifier:uniqueId.typeextensibleIdentifier Type Codes
List.identifier:entryUUID.userequiredPattern: official
List.identifier:entryUUID.typeextensibleIdentifier Type Codes
List.statusrequiredListStatus
List.moderequiredListMode
List.coderequiredMHDlistTypesVS
List.orderedBypreferredListOrderCodes
List.entry.flagexamplePatientMedicineChangeTypes
List.emptyReasonpreferredListEmptyReasons