FHIR for FAIR - FHIR Implementation Guide
1.0.0 - STU 1

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

## Resource Profile: DocumentManifestF4F - Detailed Descriptions

Active as of 2024-01-05

Definitions for the DocumentManifest-uv-f4f resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. DocumentManifest
2. DocumentManifest.extension
Slicing | This element introduces a set of slices on `DocumentManifest.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. DocumentManifest.extension:copyright
Slice Name | copyright
Control | 0..1
Type | Extension(Copyright) (Extension Type: markdown)
6. DocumentManifest.extension:licenceCodeable
Slice Name | licenceCodeable
Control | 0..1
Type | Extension(Licence Terms as CodeableConcept) (Extension Type: CodeableConcept)
8. DocumentManifest.extension:licenceAttachment
Slice Name | licenceAttachment
Control | 0..1
Type | Extension(Licence Terms as Attachment) (Extension Type: Attachment)
10. DocumentManifest.extension:subjectOther
Slice Name | subjectOther
Control | 0..*
Type | Extension(Other Subjects [Resource]) (Extension Type: Reference(Resource))
12. DocumentManifest.extension:classifier
Slice Name | classifier
Control | 0..*
Type | Extension(Classifier [Resource]) (Extension Type: CodeableConcept)
14. DocumentManifest.masterIdentifier
Short | Unique Identifier for the set of Items in manifest
16. DocumentManifest.identifier
Short | Other identifiers for the manifest.
Note | This is a business identifier, not a resource identifier (see discussion)
18. DocumentManifest.status
Short | current | superseded |entered-in-error
20. DocumentManifest.subject
Short | Subject of the listed resources
22. DocumentManifest.created
Short | When this document manifest created.
24. DocumentManifest.author
Short | Who and/or what authored the DocumentManifest.
26. DocumentManifest.description
Short | Human-readable description (title).
28. DocumentManifest.content
Short | Items in manifest.
30. DocumentManifest.related
32. DocumentManifest.related.identifier
Short | Identifiers of things that are related.
Note | This is a business identifier, not a resource identifier (see discussion)
34. DocumentManifest.related.ref
Short | Related Resource.

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..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. DocumentManifest.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional 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
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `DocumentManifest.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
6. DocumentManifest.extension:copyright
Slice Name | copyright
Definition | This extension may be used to provide Copyright information about the set of data described by this resource
Short | Copyright
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Copyright) (Extension Type: markdown)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. DocumentManifest.extension:licenceCodeable
Slice Name | licenceCodeable
Definition | This extension may be used to provide machine-processable Licence information about the set of data described by this resource
Short | Licence Terms as CodeableConcept
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Licence Terms as CodeableConcept) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. DocumentManifest.extension:licenceAttachment
Slice Name | licenceAttachment
Definition | This extension may be used to provide detailed Licence information about the set of data described by this resource
Short | Licence Terms as Attachment
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Licence Terms as Attachment) (Extension Type: Attachment)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. DocumentManifest.extension:subjectOther
Slice Name | subjectOther
Definition | This extension allows to record kinds of subjects that are not currently supported by some resources (e.g.,DocumentManifest limited to Patient, Practitioner, Group, Device for )
Short | Other Subjects [Resource]
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Other Subjects [Resource]) (Extension Type: Reference(Resource))
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. DocumentManifest.extension:classifier
Slice Name | classifier
Definition | This extension allows to assign this resource to an organizing scheme
Short | Classifier [Resource]
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Classifier [Resource]) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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 Items in manifestUnique Identifier for the set of documents
Control | 0..1
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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 | 0..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. DocumentManifest.status
Definition | The status of this document manifest.
Short | current | superseded |entered-in-errorcurrent | superseded | entered-in-error
Comments | 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 DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.3.0 The status of the document reference.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. 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 | Subject of the listed resourcesThe subject of the set of documents
Control | 0..1
Type | Reference(Patient, Practitioner, Group, Device)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. 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 | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. DocumentManifest.author
Definition | Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
Short | Who and/or what authored the DocumentManifest.
Comments | Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Organization, Device, Patient, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. 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
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Helps humans to assess whether the document is of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. DocumentManifest.content
Definition | The list of Resources that consist of the parts of this manifest.
Short | Items in manifest.
Comments | When used for XDS the intended focus of the DocumentManifest is for the reference to target to be a set of DocumentReference Resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources.
Control | 1..*
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | true
Requirements | Any Resources are allowed to be grouped in a Manifest. The manifest brings context to the group.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (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..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
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
Is Modifier | false
Must Support | false
Summary | true
4. DocumentManifest.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
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 | The codes SHOULD be taken from CommonLanguages IETF language tag
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. DocumentManifest.text
Definition | A human-readable narrative that contains a summary of the resource and can 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 information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
Invariants | dom-r4b: 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)`)
14. DocumentManifest.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `DocumentManifest.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
16. DocumentManifest.extension:copyright
Slice Name | copyright
Definition | This extension may be used to provide Copyright information about the set of data described by this resource
Short | Copyright
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Copyright) (Extension Type: markdown)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. DocumentManifest.extension:licenceCodeable
Slice Name | licenceCodeable
Definition | This extension may be used to provide machine-processable Licence information about the set of data described by this resource
Short | Licence Terms as CodeableConcept
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Licence Terms as CodeableConcept) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. DocumentManifest.extension:licenceAttachment
Slice Name | licenceAttachment
Definition | This extension may be used to provide detailed Licence information about the set of data described by this resource
Short | Licence Terms as Attachment
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Licence Terms as Attachment) (Extension Type: Attachment)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. DocumentManifest.extension:subjectOther
Slice Name | subjectOther
Definition | This extension allows to record kinds of subjects that are not currently supported by some resources (e.g.,DocumentManifest limited to Patient, Practitioner, Group, Device for )
Short | Other Subjects [Resource]
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Other Subjects [Resource]) (Extension Type: Reference(Resource))
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. DocumentManifest.extension:classifier
Slice Name | classifier
Definition | This extension allows to assign this resource to an organizing scheme
Short | Classifier [Resource]
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Classifier [Resource]) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. 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 Items in manifest
Control | 0..1
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. 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 | 0..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. DocumentManifest.status
Definition | The status of this document manifest.
Short | current | superseded |entered-in-error
Comments | 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 DocumentReferenceStatus The status of the document reference.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. DocumentManifest.type
Definition | The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
Short | Kind of document set
Comments | 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.
Control | 0..1
Binding | For example codes, see v3 Code System ActCode The activity that caused the DocumentManifest to be created.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. 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 | Subject of the listed resources
Control | 0..1
Type | Reference(Patient, Practitioner, Group, Device)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. 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 | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. DocumentManifest.author
Definition | Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
Short | Who and/or what authored the DocumentManifest.
Comments | Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Organization, Device, Patient, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. 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, PractitionerRole, RelatedPerson, Organization)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. DocumentManifest.source
Definition | Identifies the source system, application, or software that produced the document manifest.
Short | The source system/application/software
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. 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
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Helps humans to assess whether the document is of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. DocumentManifest.content
Definition | The list of Resources that consist of the parts of this manifest.
Short | Items in manifest.
Comments | When used for XDS the intended focus of the DocumentManifest is for the reference to target to be a set of DocumentReference Resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources.
Control | 1..*
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | true
Requirements | Any Resources are allowed to be grouped in a Manifest. The manifest brings context to the group.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. DocumentManifest.related
Definition | Related identifiers or resources associated with the DocumentManifest.
Short | Related things
Comments | May be identifiers or resources that caused the DocumentManifest to be created.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`)
52. DocumentManifest.related.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 | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
54. DocumentManifest.related.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
56. DocumentManifest.related.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
58. DocumentManifest.related.identifier
Definition | Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.
Short | Identifiers of things that are related.
Comments | If both identifier and ref elements are present they shall refer to the same thing.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. DocumentManifest.related.ref
Definition | Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.
Short | Related Resource.
Comments | If both identifier and ref elements are present they shall refer to the same thing.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)