Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2019-07-29 |
Definitions for the IHE.MHD.DocumentManifest resource profile.
Guidance on how to interpret the contents of this table can be found here
0. DocumentManifest | |
2. DocumentManifest.text | |
4. DocumentManifest.masterIdentifier | |
Control | 1..? |
6. DocumentManifest.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..? |
8. DocumentManifest.status | |
Comments | approved -> status=current |
10. DocumentManifest.type | |
Control | 1..? |
12. DocumentManifest.subject | |
Comments | Not a contained resource. URL Points to an existing Patient resource representing Affinity Domain Patient |
Control | 1..? |
Type | Reference(Patient) |
14. DocumentManifest.created | |
Control | 1..? |
16. DocumentManifest.author | |
Comments | Contained resource of type Practitioner or Organization with: * authorInstitution: Organization For Practionioner, also with: * authorPerson: Practitioner.identifier and Practitioner.name * authorRole:—Not supported in STU3 * authorSpecialty: Practitioner.qualification * authorTelecommunication: Practitioner.telecom |
Type | Reference(Practitioner, Organization) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
18. DocumentManifest.source | |
Control | 1..? |
20. DocumentManifest.content | |
22. DocumentManifest.content.p[x] | |
Comments | DocumentManifest.content.pAttachment is not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. Added a type slice and set the rules to closed to enforce constraining of pAttachment. |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on DocumentManifest.content.p[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: |
24. DocumentManifest.content.p[x]:pReference | |
Slice Name | pReference |
Type | Reference(Nictiz IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Minimal Metadata, see Table 3:4.3.1-3., DocumentReference) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
26. DocumentManifest.related | |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
0. DocumentManifest | |
Definition | A collection of documents compiled for a purpose together with metadata that applies to the collection. |
Short | A list that defines a set of documents |
Control | 0..* |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty() )dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
2. 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. |
Short | A set of rules under which this content was created |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Control | 0..1 |
Type | uri |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
4. DocumentManifest.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Short | Text summary of the resource, for human interpretation |
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 in formation is added later. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
6. 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. Usually modifier elements provide negation or qualification. In order 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. |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Alternate Names | extensions, user content |
8. DocumentManifest.masterIdentifier | |
Definition | A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts. |
Short | Unique Identifier for the set of documents |
Control | 10..1 |
Type | Identifier |
Summary | true |
10. DocumentManifest.identifier | |
Definition | Other identifiers associated with the document manifest, including version independent identifiers. |
Short | Other identifiers for the manifest |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* |
Type | Identifier |
Summary | true |
12. DocumentManifest.status | |
Definition | The status of this document manifest. |
Short | current | superseded | entered-in-error |
Comments | approved -> status=current This element is labeled as a modifier because the status contains the codes that mark the manifest as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status (required to http://hl7.org/fhir/ValueSet/document-reference-status )The status of the document reference. |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
14. DocumentManifest.type | |
Definition | 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. |
Short | Kind of document set |
Control | 10..1 |
Binding | The codes SHOULD be taken from Document Type Value Sethttp://hl7.org/fhir/ValueSet/c80-doc-typecodes (preferred to http://hl7.org/fhir/ValueSet/c80-doc-typecodes )Precise type of clinical document. |
Type | CodeableConcept |
Summary | true |
16. 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). |
Short | The subject of the set of documents |
Comments | Not a contained resource. URL Points to an existing Patient resource representing Affinity Domain Patient |
Control | 10..1 |
Type | Reference(Patient, Practitioner, Group, Device) |
Summary | true |
18. 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.). |
Short | When this document manifest created |
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. |
Control | 10..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
20. DocumentManifest.author | |
Definition | Identifies who is responsible for creating the manifest, and adding documents to it. |
Short | Who and/or what authored the manifest |
Comments | Contained resource of type Practitioner or Organization with: * authorInstitution: Organization For Practionioner, also with: * authorPerson: Practitioner.identifier and Practitioner.name * authorRole:—Not supported in STU3 * authorSpecialty: Practitioner.qualification * authorTelecommunication: Practitioner.telecom Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant). |
Control | 0..* |
Type | Reference(Practitioner, Organization, Device, Patient, RelatedPerson) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
22. DocumentManifest.source | |
Definition | Identifies the source system, application, or software that produced the document manifest. |
Short | The source system/application/software |
Control | 10..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
24. DocumentManifest.content | |
Definition | The list of Documents included in the manifest. |
Short | The items included |
Control | 1..* |
Type | BackboneElement |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
26. DocumentManifest.content.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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Summary | true |
Alternate Names | extensions, user content, modifiers |
28. DocumentManifest.content.p[x] | |
Definition | The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed. |
Short | Contents of this set of documents |
Comments | DocumentManifest.content.pAttachment is not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. Added a type slice and set the rules to closed to enforce constraining of pAttachment. The intended focus of the DocumentManifest is for the reference to target either DocumentReference or Media Resources, and most implementation guides will restrict to these resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources. |
Control | 1..1 |
Type | Choice of: Attachment, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Slicing | This element introduces a set of slices on DocumentManifest.content.p[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
30. DocumentManifest.content.p[x]:pReference | |
Slice Name | pReference |
Definition | The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed. |
Short | Contents of this set of documents |
Comments | The intended focus of the DocumentManifest is for the reference to target either DocumentReference or Media Resources, and most implementation guides will restrict to these resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources. |
Control | 1..1 |
Type | Reference(Nictiz IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Minimal Metadata, see Table 3:4.3.1-3., DocumentReference, Resource), Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
32. DocumentManifest.related | |
Definition | Related identifiers or resources associated with the DocumentManifest. |
Short | Related things |
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. May be identifiers or resources that caused the DocumentManifest to be created. |
Control | 0..0* |
Type | BackboneElement |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. DocumentManifest | |||||
Definition | A collection of documents compiled for a purpose together with metadata that applies to the collection. | ||||
Short | A list that defines a set of documents | ||||
Control | 0..* | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty() ) | ||||
2. DocumentManifest.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
4. DocumentManifest.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
6. 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. | ||||
Short | A set of rules under which this content was created | ||||
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
8. DocumentManifest.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
10. DocumentManifest.text | |||||
Definition | A human-readable narrative that contains a summary of the resource, and may 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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
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 in formation is added later. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
12. 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. | ||||
Short | Contained, inline 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. DocumentManifest.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
16. 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. Usually modifier elements provide negation or qualification. In order 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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Alternate Names | extensions, user content | ||||
18. DocumentManifest.masterIdentifier | |||||
Definition | A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts. | ||||
Short | Unique Identifier for the set of documents | ||||
Control | 1..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
20. DocumentManifest.identifier | |||||
Definition | Other identifiers associated with the document manifest, including version independent identifiers. | ||||
Short | Other identifiers for the manifest | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..* | ||||
Type | Identifier | ||||
Summary | true | ||||
22. DocumentManifest.status | |||||
Definition | The status of this document manifest. | ||||
Short | current | superseded | entered-in-error | ||||
Comments | approved -> status=current | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from DocumentReferenceStatus (required to http://hl7.org/fhir/ValueSet/document-reference-status )The status of the document reference. | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
24. DocumentManifest.type | |||||
Definition | 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. | ||||
Short | Kind of document set | ||||
Control | 1..1 | ||||
Binding | The codes SHOULD be taken from Document Type Value Set (preferred to http://hl7.org/fhir/ValueSet/c80-doc-typecodes )Precise type of clinical document. | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
26. 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). | ||||
Short | The subject of the set of documents | ||||
Comments | Not a contained resource. URL Points to an existing Patient resource representing Affinity Domain Patient | ||||
Control | 1..1 | ||||
Type | Reference(Patient) | ||||
Summary | true | ||||
28. 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.). | ||||
Short | When this document manifest created | ||||
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. | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
30. DocumentManifest.author | |||||
Definition | Identifies who is responsible for creating the manifest, and adding documents to it. | ||||
Short | Who and/or what authored the manifest | ||||
Comments | Contained resource of type Practitioner or Organization with: * authorInstitution: Organization For Practionioner, also with: * authorPerson: Practitioner.identifier and Practitioner.name * authorRole:—Not supported in STU3 * authorSpecialty: Practitioner.qualification * authorTelecommunication: Practitioner.telecom | ||||
Control | 0..* | ||||
Type | Reference(Practitioner, Organization) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
32. DocumentManifest.recipient | |||||
Definition | A patient, practitioner, or organization for which this set of documents is intended. | ||||
Short | Intended to get notified about this set of documents | ||||
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. | ||||
Control | 0..* | ||||
Type | Reference(Patient, Practitioner, RelatedPerson, Organization) | ||||
Summary | true | ||||
34. DocumentManifest.source | |||||
Definition | Identifies the source system, application, or software that produced the document manifest. | ||||
Short | The source system/application/software | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
36. DocumentManifest.description | |||||
Definition | Human-readable description of the source document. This is sometimes known as the "title". | ||||
Short | Human-readable description (title) | ||||
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"). | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Helps humans to assess whether the document is of interest. | ||||
38. DocumentManifest.content | |||||
Definition | The list of Documents included in the manifest. | ||||
Short | The items included | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
40. DocumentManifest.content.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
42. DocumentManifest.content.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
44. DocumentManifest.content.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 that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
46. DocumentManifest.content.p[x] | |||||
Definition | The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed. | ||||
Short | Contents of this set of documents | ||||
Comments | DocumentManifest.content.pAttachment is not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. Added a type slice and set the rules to closed to enforce constraining of pAttachment. | ||||
Control | 1..1 | ||||
Type | Choice of: Attachment, Reference(Resource) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Slicing | This element introduces a set of slices on DocumentManifest.content.p[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
48. DocumentManifest.content.p[x]:pReference | |||||
Slice Name | pReference | ||||
Definition | The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed. | ||||
Short | Contents of this set of documents | ||||
Comments | The intended focus of the DocumentManifest is for the reference to target either DocumentReference or Media Resources, and most implementation guides will restrict to these resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources. | ||||
Control | 1..1 | ||||
Type | Reference(Nictiz IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Minimal Metadata, see Table 3:4.3.1-3., DocumentReference) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
50. DocumentManifest.related | |||||
Definition | Related identifiers or resources associated with the DocumentManifest. | ||||
Short | Related things | ||||
Comments | These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) |