Cross Border Data Exchange IG
1.0.0 - CI Build
Cross Border Data Exchange IG
1.0.0 - CI Build
Cross Border Data Exchange IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/cross-border-data-exchange/ and changes regularly. See the Directory of published versions
| Official URL: http://interopehrate.eu/fhir/StructureDefinition/DocumentManifest-IEHR | Version: 1.0.0 | |||
| Draft as of 2024-04-08 | Computable Name: DocumentManifestIEHR | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentManifest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DocumentManifest |
0..* | DocumentManifest | A list that defines a set of documents | |
  extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
 type |
S | 1..1 | CodeableConcept | Kind of document set |
 subject |
S | 1..1 | Reference(Patient-IEHR | Practitioner (IPS) | Group | Device) | The subject of the set of documents |
| created |
S | 1..1 | dateTime | When this document manifest created |
| author |
1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | Device | Patient-IEHR | RelatedPerson) | Who and/or what authored the DocumentManifest | |
| content |
1..* | Reference(DocumentReference-IEHR) | Items in manifest | |
 related |
0..* | BackboneElement | Related things | |
  ref |
0..1 | Reference(Resource) | Related Resource | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentManifest |
0..* | DocumentManifest | A list that defines a set of documents | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
 type |
SΣ | 1..1 | CodeableConcept | Kind of document set Binding: v3 Code System ActCode (example): The activity that caused the DocumentManifest to be created. |
| subject |
SΣ | 1..1 | Reference(Patient-IEHR | Practitioner (IPS) | Group | Device) | The subject of the set of documents |
| created |
S | 1..1 | dateTime | When this document manifest created |
| author |
Σ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | Device | Patient-IEHR | RelatedPerson) | Who and/or what authored the DocumentManifest |
| content |
Σ | 1..* | Reference(DocumentReference-IEHR) | Items in manifest |
| related |
0..* | BackboneElement | Related things | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ref |
0..1 | Reference(Resource) | Related Resource | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentManifest.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | |
| DocumentManifest.type | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DocumentManifest | 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 | error | DocumentManifest | 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 | error | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DocumentManifest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentManifest |
0..* | DocumentManifest | A list that defines a set of documents | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| masterIdentifier |
Σ | 0..1 | Identifier | Unique Identifier for the set of documents | ||||
| identifier |
Σ | 0..* | Identifier | Other identifiers for the manifest | ||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Kind of document set Binding: v3 Code System ActCode (example): The activity that caused the DocumentManifest to be created. | ||||
| subject |
SΣ | 1..1 | Reference(Patient-IEHR | Practitioner (IPS) | Group | Device) | The subject of the set of documents | ||||
| created |
S | 1..1 | dateTime | When this document manifest created | ||||
| author |
Σ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | Device | Patient-IEHR | RelatedPerson) | Who and/or what authored the DocumentManifest | ||||
| recipient |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Intended to get notified about this set of documents | |||||
| source |
0..1 | uri | The source system/application/software | |||||
| description |
Σ | 0..1 | string | Human-readable description (title) | ||||
| content |
Σ | 1..* | Reference(DocumentReference-IEHR) | Items in manifest | ||||
| related |
0..* | BackboneElement | Related things | |||||
| 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 | ||||
| identifier |
0..1 | Identifier | Identifiers of things that are related | |||||
| ref |
0..1 | Reference(Resource) | Related Resource | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentManifest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DocumentManifest.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentManifest.type | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DocumentManifest | 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 | error | DocumentManifest | 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 | error | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DocumentManifest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DocumentManifest
Summary
Mandatory: 4 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from DocumentManifest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentManifest |
0..* | DocumentManifest | A list that defines a set of documents | |
| extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| type |
S | 1..1 | CodeableConcept | Kind of document set |
| subject |
S | 1..1 | Reference(Patient-IEHR | Practitioner (IPS) | Group | Device) | The subject of the set of documents |
| created |
S | 1..1 | dateTime | When this document manifest created |
| author |
1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | Device | Patient-IEHR | RelatedPerson) | Who and/or what authored the DocumentManifest | |
| content |
1..* | Reference(DocumentReference-IEHR) | Items in manifest | |
| related |
0..* | BackboneElement | Related things | |
| ref |
0..1 | Reference(Resource) | Related Resource | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentManifest |
0..* | DocumentManifest | A list that defines a set of documents | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
| type |
SΣ | 1..1 | CodeableConcept | Kind of document set Binding: v3 Code System ActCode (example): The activity that caused the DocumentManifest to be created. |
| subject |
SΣ | 1..1 | Reference(Patient-IEHR | Practitioner (IPS) | Group | Device) | The subject of the set of documents |
| created |
S | 1..1 | dateTime | When this document manifest created |
| author |
Σ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | Device | Patient-IEHR | RelatedPerson) | Who and/or what authored the DocumentManifest |
| content |
Σ | 1..* | Reference(DocumentReference-IEHR) | Items in manifest |
| related |
0..* | BackboneElement | Related things | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ref |
0..1 | Reference(Resource) | Related Resource | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentManifest.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | |
| DocumentManifest.type | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DocumentManifest | 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 | error | DocumentManifest | 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 | error | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DocumentManifest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentManifest |
0..* | DocumentManifest | A list that defines a set of documents | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| masterIdentifier |
Σ | 0..1 | Identifier | Unique Identifier for the set of documents | ||||
| identifier |
Σ | 0..* | Identifier | Other identifiers for the manifest | ||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Kind of document set Binding: v3 Code System ActCode (example): The activity that caused the DocumentManifest to be created. | ||||
| subject |
SΣ | 1..1 | Reference(Patient-IEHR | Practitioner (IPS) | Group | Device) | The subject of the set of documents | ||||
| created |
S | 1..1 | dateTime | When this document manifest created | ||||
| author |
Σ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | Device | Patient-IEHR | RelatedPerson) | Who and/or what authored the DocumentManifest | ||||
| recipient |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Intended to get notified about this set of documents | |||||
| source |
0..1 | uri | The source system/application/software | |||||
| description |
Σ | 0..1 | string | Human-readable description (title) | ||||
| content |
Σ | 1..* | Reference(DocumentReference-IEHR) | Items in manifest | ||||
| related |
0..* | BackboneElement | Related things | |||||
| 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 | ||||
| identifier |
0..1 | Identifier | Identifiers of things that are related | |||||
| ref |
0..1 | Reference(Resource) | Related Resource | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentManifest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DocumentManifest.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentManifest.type | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DocumentManifest | 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 | error | DocumentManifest | 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 | error | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DocumentManifest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DocumentManifest
Summary
Mandatory: 4 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron