This page is part of the IHE Mobile Access to Health Documents (v4.2.2: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: MHD Folder Comprehensive

A profile on the List resource for MHD Comprehensive Metadata Folder. Note UnContained has no impact on Folder.

• MHD is based on the IHE Document Sharing model,
• the 3:4.1 Abstract Metadata Model, and
• the use defined here is FHIR List for use as a Folder implementation of the
• ebRIM implementation at 3:4.2.3.4 Folder Attributes.
• with use-cases and constraints found in 3:4.3 Additional Document Sharing Requirements

Usage:

• Examples for this Resource Profile: List/ex-compFolder

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Folder

Name	Flags	Card.	Type	Description & Constraints
List		0..*	Folder	A list is a curated collection of resources
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:designationType		1..*	DesignationType	Clinical code of the List
title		1..1	string	Descriptive name for the list
subject		1..1	Reference(Patient)	If all resources have the same subject
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	Folder	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		1..*	Extension	Extension Slice: Unordered, Open by value:url
designationType	S	1..*	CodeableConcept	Clinical code of the List URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
Slices for identifier		0..*	Identifier	Business identifier Slice: Unordered, Open by value:use
identifier:uniqueId		0..1	UniqueIdIdentifier	An identifier intended for computation
identifier:entryUUID		0..*	EntryUUIDIdentifier	An identifier intended for computation
status	?!Σ	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode	?!Σ	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working
title	Σ	1..1	string	Descriptive name for the list Example General: Dr. Jane's Patients
code	Σ	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: folder
subject	SΣ	1..1	Reference(Patient)	If all resources have the same subject
note		0..1	Annotation	Comments about the list
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.status	required	ListStatus http://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard
List.mode	required	Pattern: working http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
List.code	required	Pattern: folder https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS from this IG

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	Folder	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
designationType	S	1..*	CodeableConcept	Clinical code of the List URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
Slices for identifier		0..*	Identifier	Business identifier Slice: Unordered, Open by value:use
identifier:uniqueId		0..1	UniqueIdIdentifier	An identifier intended for computation
identifier:entryUUID		0..*	EntryUUIDIdentifier	An identifier intended for computation
status	?!Σ	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode	?!Σ	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working
title	Σ	1..1	string	Descriptive name for the list Example General: Dr. Jane's Patients
code	Σ	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: folder
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(Patient)	If all resources have the same subject
date	Σ	0..1	dateTime	When the list was prepared
note		0..1	Annotation	Comments about the list
entry	C	0..*	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		1..1	Reference(DocumentReference)	Actual entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
List.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
List.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
List.status	required	ListStatus http://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard
List.mode	required	Pattern: working http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
List.code	required	Pattern: folder https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS from this IG

This structure is derived from Folder

Summary

Mandatory: 4 elements

Differential View

This structure is derived from Folder

Name	Flags	Card.	Type	Description & Constraints
List		0..*	Folder	A list is a curated collection of resources
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:designationType		1..*	DesignationType	Clinical code of the List
title		1..1	string	Descriptive name for the list
subject		1..1	Reference(Patient)	If all resources have the same subject
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	Folder	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		1..*	Extension	Extension Slice: Unordered, Open by value:url
designationType	S	1..*	CodeableConcept	Clinical code of the List URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
Slices for identifier		0..*	Identifier	Business identifier Slice: Unordered, Open by value:use
identifier:uniqueId		0..1	UniqueIdIdentifier	An identifier intended for computation
identifier:entryUUID		0..*	EntryUUIDIdentifier	An identifier intended for computation
status	?!Σ	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode	?!Σ	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working
title	Σ	1..1	string	Descriptive name for the list Example General: Dr. Jane's Patients
code	Σ	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: folder
subject	SΣ	1..1	Reference(Patient)	If all resources have the same subject
note		0..1	Annotation	Comments about the list
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.status	required	ListStatus http://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard
List.mode	required	Pattern: working http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
List.code	required	Pattern: folder https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	Folder	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
designationType	S	1..*	CodeableConcept	Clinical code of the List URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
Slices for identifier		0..*	Identifier	Business identifier Slice: Unordered, Open by value:use
identifier:uniqueId		0..1	UniqueIdIdentifier	An identifier intended for computation
identifier:entryUUID		0..*	EntryUUIDIdentifier	An identifier intended for computation
status	?!Σ	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode	?!Σ	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working
title	Σ	1..1	string	Descriptive name for the list Example General: Dr. Jane's Patients
code	Σ	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: folder
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(Patient)	If all resources have the same subject
date	Σ	0..1	dateTime	When the list was prepared
note		0..1	Annotation	Comments about the list
entry	C	0..*	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		1..1	Reference(DocumentReference)	Actual entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
List.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
List.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
List.status	required	ListStatus http://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard
List.mode	required	Pattern: working http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
List.code	required	Pattern: folder https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS from this IG

This structure is derived from Folder

Summary

Mandatory: 4 elements

Other representations of profile: CSV, Excel, Schematron