0.4.4 - ci-build

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest 0..*DocumentManifestA list that defines a set of documents
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... content Σ1..*Reference(Resource)Items in manifest

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentManifest.statusrequiredDocumentReferenceStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentManifestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentManifestIf 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-4errorDocumentManifestIf 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-5errorDocumentManifestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentManifestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest 0..*DocumentManifestA list that defines a set of documents
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier Σ0..1IdentifierUnique Identifier for the set of documents
... identifier Σ0..*IdentifierOther identifiers for the manifest
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type Σ0..1CodeableConceptKind of document set
Binding: v3 Code System ActCode (example): The activity that caused the DocumentManifest to be created.

... subject SΣ1..1Reference(Patient | Practitioner | Group | Device)The subject of the set of documents
... created 0..1dateTimeWhen 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..1uriThe source system/application/software
... description Σ0..1stringHuman-readable description (title)
... content Σ1..*Reference(Resource)Items in manifest
... related 0..*BackboneElementRelated things
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1IdentifierIdentifiers of things that are related
.... ref 0..1Reference(Resource)Related Resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentManifest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentManifest.statusrequiredDocumentReferenceStatus
DocumentManifest.typeexampleActCode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentManifestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentManifestIf 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-4errorDocumentManifestIf 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-5errorDocumentManifestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentManifestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DocumentManifest

Summary

Mandatory: 1 element
Must-Support: 1 element

Differential View

This structure is derived from DocumentManifest

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest 0..*DocumentManifestA list that defines a set of documents
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... content Σ1..*Reference(Resource)Items in manifest

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentManifest.statusrequiredDocumentReferenceStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentManifestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentManifestIf 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-4errorDocumentManifestIf 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-5errorDocumentManifestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentManifestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest 0..*DocumentManifestA list that defines a set of documents
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier Σ0..1IdentifierUnique Identifier for the set of documents
... identifier Σ0..*IdentifierOther identifiers for the manifest
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type Σ0..1CodeableConceptKind of document set
Binding: v3 Code System ActCode (example): The activity that caused the DocumentManifest to be created.

... subject SΣ1..1Reference(Patient | Practitioner | Group | Device)The subject of the set of documents
... created 0..1dateTimeWhen 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..1uriThe source system/application/software
... description Σ0..1stringHuman-readable description (title)
... content Σ1..*Reference(Resource)Items in manifest
... related 0..*BackboneElementRelated things
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..1IdentifierIdentifiers of things that are related
.... ref 0..1Reference(Resource)Related Resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentManifest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentManifest.statusrequiredDocumentReferenceStatus
DocumentManifest.typeexampleActCode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentManifestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentManifestIf 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-4errorDocumentManifestIf 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-5errorDocumentManifestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentManifestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DocumentManifest

Summary

Mandatory: 1 element
Must-Support: 1 element

 

Other representations of profile: CSV, Excel, Schematron