CH EPR mHealth (R4)
0.1.1 - Draft Standard for Trial Use

This page is part of the CH EPR mHealth (R4) (v0.1.1: DSTU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

StructureDefinition: IHE_MHD_Comprehensive_DocumentManifest_CH - Detailed Descriptions

Definitions for the ch-mhd-comprehensive-documentmanifest Profile.

1. DocumentManifest
Definition

A collection of documents compiled for a purpose together with metadata that applies to the collection.

Control0..*
InvariantsDefined on this element
ch-mhd: The resource is not conform to the MHD profile from https://github.com/IHE/ITI.MHD (: conformsTo('http://ihe.net/fhir/ihe.mhd.fhir/StructureDefinition/IHE.MHD.Comprehensive.DocumentManifest'))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. DocumentManifest.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typestring
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. DocumentManifest.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. DocumentManifest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. DocumentManifest.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. DocumentManifest.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. DocumentManifest.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. DocumentManifest.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DocumentManifest.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. DocumentManifest.extension:authorAuthorRole
SliceNameauthorAuthorRole
Definition

Extension

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(ChExtAuthorAuthorRole) (Extension Type: Coding)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. DocumentManifest.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. DocumentManifest.masterIdentifier
Definition

A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.

Control1..1
TypeIdentifier
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. DocumentManifest.identifier
Definition

Other identifiers associated with the document manifest, including version independent identifiers.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. DocumentManifest.status
Definition

The status of this document manifest.

Control1..1
BindingThe status of the document reference.
The codes SHALL be taken from DocumentReferenceStatus
Typecode
Is Modifiertrue
Comments

approved -> status=current

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. DocumentManifest.type
Definition

The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.

Control1..1
BindingThe codes SHALL be taken from SubmissionSet.contentTypeCode
TypeCodeableConcept
Comments

Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. DocumentManifest.subject
Definition

Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).

Control1..1
TypeReference(CHCorePatient)
Comments

Not a contained resource. URL Points to an existing Patient resource representing Affinity Domain Patient.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. DocumentManifest.created
Definition

When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).

Control1..1
TypedateTime
Comments

Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. DocumentManifest.author
Definition

Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.

Control0..*
TypeReference(CHCorePractitioner | CHCorePractitionerRole | CHCoreOrganization | Device | CHCorePatient | RelatedPerson)
Must Supporttrue
Comments

Contained resource.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. DocumentManifest.recipient
Definition

A patient, practitioner, or organization for which this set of documents is intended.

Control0..*
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
Comments

How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. DocumentManifest.source
Definition

Identifies the source system, application, or software that produced the document manifest.

Control1..1
Typeuri
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. DocumentManifest.description
Definition

Human-readable description of the source document. This is sometimes known as the "title".

Control0..1
Typestring
Requirements

Helps humans to assess whether the document is of interest.

Comments

What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note").

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. DocumentManifest.content
Definition

The list of Resources that consist of the parts of this manifest.

Control1..*
TypeReference(IHE_MHD_Provide_Comprehensive_DocumentReference_CH)
Requirements

Any Resources are allowed to be grouped in a Manifest. The manifest brings context to the group.

Comments

When used for XDS the intended focus of the DocumentManifest is for the reference to target to be a set of DocumentReference Resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. DocumentManifest.related
Definition

Related identifiers or resources associated with the DocumentManifest.

Control0..0
TypeBackboneElement
Comments

These HL7 FHIR elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. DocumentManifest.related.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
24. DocumentManifest.related.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
25. DocumentManifest.related.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
26. DocumentManifest.related.identifier
Definition

Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Comments

If both identifier and ref elements are present they shall refer to the same thing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. DocumentManifest.related.ref
Definition

Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.

Control0..1
TypeReference(Resource)
Comments

If both identifier and ref elements are present they shall refer to the same thing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))