StandardPatientHealthRecordIG, published by MITRE. This is not an authorized publication; it is the continuous build for version 0.4.4). This version is based on the current content of https://github.com/HL7/standard-patient-health-record-ig/ and changes regularly. See the Directory of published versions
Resource Profile: PhrDocumentManifest
| Official URL: https://open-health-manager.github.io/standard-patient-health-record-ig/StructureDefinition/PhrDocumentManifest | Version: 0.4.4 | |||
| Draft as of 2023-09-13 | Computable Name: PhrDocumentManifest | |||
Standard PHR profile of the DocumentManifest resource.
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
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 | |
  subject | S | 1..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents |
| 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 |
 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. |
 subject | SΣ | 1..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents |
| content | Σ | 1..* | Reference(Resource) | Items in manifest |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| DocumentManifest.status | required | DocumentReferenceStatus |
Constraints
| 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 | 0..* | Extension | Additional content defined by implementations | |||||
| 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 | Σ | 0..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 | Practitioner | Group | Device) | The subject of the set of documents | ||||
| created | 0..1 | dateTime | When this document manifest created | |||||
| author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | 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(Resource) | 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 | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| DocumentManifest.language | preferred | CommonLanguages
| ||||
| DocumentManifest.status | required | DocumentReferenceStatus | ||||
| DocumentManifest.type | example | ActCode |
Constraints
| 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
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 | |
| subject | S | 1..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents |
| 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 |
| 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. |
| subject | SΣ | 1..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents |
| content | Σ | 1..* | Reference(Resource) | Items in manifest |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| DocumentManifest.status | required | DocumentReferenceStatus |
Constraints
| 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 | 0..* | Extension | Additional content defined by implementations | |||||
| 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 | Σ | 0..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 | Practitioner | Group | Device) | The subject of the set of documents | ||||
| created | 0..1 | dateTime | When this document manifest created | |||||
| author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | 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(Resource) | 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 | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| DocumentManifest.language | preferred | CommonLanguages
| ||||
| DocumentManifest.status | required | DocumentReferenceStatus | ||||
| DocumentManifest.type | example | ActCode |
Constraints
| 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
Other representations of profile: CSV, Excel, Schematron