FHIR for FAIR - FHIR Implementation Guide, published by Health Level Seven International - SOA Work Group. 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/HL7/fhir-for-fair/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: DocumentManifest [Subject Level Medatata]

This profile defines how to use the DocumentManifest resource to convey subject level metadata information for a FAIR collection of data by using HL7 FHIR

Usage:

• Examples for this Resource Profile: DocumentManifest/example-f4f-manifest

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from DocumentManifest

Name	Flags	Card.	Type	Description & Constraints
DocumentManifest		0..*	DocumentManifest	A list that defines a set of documents
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
copyright		0..1	markdown	Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable		0..1	CodeableConcept	Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment		0..1	Attachment	Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther		0..*	Reference(Resource)	Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier		0..*	CodeableConcept	Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
masterIdentifier		0..1	Identifier	Unique Identifier for the set of Items in manifest
identifier		0..*	Identifier	Other identifiers for the manifest.
status		1..1	code	current | superseded |entered-in-error
subject		0..1	Reference(Patient | Practitioner | Group | Device)	Subject of the listed resources
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.
description		0..1	string	Human-readable description (title).
content		1..*	Reference(Resource)	Items in manifest.
related
identifier		0..1	Identifier	Identifiers of things that are related.
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
copyright		0..1	markdown	Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable		0..1	CodeableConcept	Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment		0..1	Attachment	Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther		0..*	Reference(Resource)	Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier		0..*	CodeableConcept	Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Unique Identifier for the set of Items in manifest
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.
subject	Σ	0..1	Reference(Patient | Practitioner | Group | Device)	Subject of the listed resources
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.
description	Σ	0..1	string	Human-readable description (title).
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.exists() and ('#'+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(uri) = '#').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): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
copyright		0..1	markdown	Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable		0..1	CodeableConcept	Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment		0..1	Attachment	Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther		0..*	Reference(Resource)	Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier		0..*	CodeableConcept	Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Unique Identifier for the set of Items in manifest
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	Σ	0..1	Reference(Patient | Practitioner | Group | Device)	Subject of the listed resources
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 Additional Bindings Purpose AllLanguages Max Binding
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b	warning	DocumentManifest.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
copyright		0..1	markdown	Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable		0..1	CodeableConcept	Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment		0..1	Attachment	Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther		0..*	Reference(Resource)	Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier		0..*	CodeableConcept	Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
masterIdentifier		0..1	Identifier	Unique Identifier for the set of Items in manifest
identifier		0..*	Identifier	Other identifiers for the manifest.
status		1..1	code	current | superseded |entered-in-error
subject		0..1	Reference(Patient | Practitioner | Group | Device)	Subject of the listed resources
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.
description		0..1	string	Human-readable description (title).
content		1..*	Reference(Resource)	Items in manifest.
related
identifier		0..1	Identifier	Identifiers of things that are related.
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
copyright		0..1	markdown	Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable		0..1	CodeableConcept	Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment		0..1	Attachment	Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther		0..*	Reference(Resource)	Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier		0..*	CodeableConcept	Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Unique Identifier for the set of Items in manifest
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.
subject	Σ	0..1	Reference(Patient | Practitioner | Group | Device)	Subject of the listed resources
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.
description	Σ	0..1	string	Human-readable description (title).
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.exists() and ('#'+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(uri) = '#').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): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
copyright		0..1	markdown	Copyright URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
licenceCodeable		0..1	CodeableConcept	Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
licenceAttachment		0..1	Attachment	Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
subjectOther		0..*	Reference(Resource)	Other Subjects [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
classifier		0..*	CodeableConcept	Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Unique Identifier for the set of Items in manifest
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	Σ	0..1	Reference(Patient | Practitioner | Group | Device)	Subject of the listed resources
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 Additional Bindings Purpose AllLanguages Max Binding
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b	warning	DocumentManifest.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright
• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
• http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier

Other representations of profile: CSV, Excel, Schematron