FHIR for FAIR - FHIR Implementation Guide
0.1.0 - STU 1 Ballot
FHIR for FAIR - FHIR Implementation Guide
0.1.0 - STU 1 Ballot
This page is part of the FHIR for FAIR - FHIR Implementation Guide (v0.1.0: STU 1 (FHIR R4b) Ballot 1) based on FHIR v4.1.0. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/DocumentManifest-uv-f4f |
| Version: | 0.1.0 |
| Name: | DocumentManifestF4F |
| Title: | DocumentManifest (Subject Level Medatata) |
| Status: | Active as of 12/5/21 12:01 AM |
| Definition: | This profile defines how to use the DocumentManifest resource to convey metadata information for a FAIR collection of data at the subject level realized by using HL7 FHIR |
| Publisher: | Health Level Seven International - SOA Work Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/DocumentManifest-uv-f4f
Balloters are invited to provide thier feedback about the best solution for recording the FAIR persistent identifier for this resource.
Possible choices are:
- By using the
masterIdentifierelement with the system valorized with 'urn:ietf:rfc:3986' and the value with the persistent url. This case is described in the provided example.- By using the
persistentUrlextension defined in this guide, as suggested for the other non-canonical resources
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentManifest
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 and Licence URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright | |
 masterIdentifier | S | 0..1 | Identifier | Unique Identifier for the set of documents |
| identifier | S | 0..* | Identifier | Other identifiers for the manifest |
| status | S | 1..1 | code | current | superseded | entered-in-error |
| created | S | 0..1 | dateTime | When this document manifest created |
| author | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the DocumentManifest |
| description | S | 0..1 | string | Human-readable description (title) |
| content | S | 1..* | Reference(Resource) | Items in manifest |
 related | S | 0..* | BackboneElement | Related things |
| Documentation for this format | ||||
| 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) Max Binding: AllLanguages: IETF language tag | |
| 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 and Licence URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| masterIdentifier | SΣ | 0..1 | Identifier | Unique Identifier for the set of documents |
| identifier | SΣ | 0..* | Identifier | Other identifiers for the manifest |
| status | ?!SΣ | 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: http://terminology.hl7.org/ValueSet/v3-ActCode (example): The activity that caused the DocumentManifest to be created. |
 subject | Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents |
| created | S | 0..1 | dateTime | When this document manifest created |
| author | SΣ | 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 | SΣ | 0..1 | string | Human-readable description (title) |
| content | SΣ | 1..* | Reference(Resource) | Items in manifest |
 related | S | 0..* | BackboneElement | Related things |
 id | 0..1 | id | 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentManifest | 0..* | DocumentManifest | A list that defines a set of documents | |
| 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. |
| 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 | 0..* | BackboneElement | Related things | |
| Documentation for this format | ||||
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 | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| copyright | 0..1 | markdown | Copyright and Licence URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright | |
| masterIdentifier | S | 0..1 | Identifier | Unique Identifier for the set of documents |
| identifier | S | 0..* | Identifier | Other identifiers for the manifest |
| status | S | 1..1 | code | current | superseded | entered-in-error |
| created | S | 0..1 | dateTime | When this document manifest created |
| author | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the DocumentManifest |
| description | S | 0..1 | string | Human-readable description (title) |
| content | S | 1..* | Reference(Resource) | Items in manifest |
| related | S | 0..* | BackboneElement | Related things |
| Documentation for this format | ||||
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) Max Binding: AllLanguages: IETF language tag | |
| 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 and Licence URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/copyright | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| masterIdentifier | SΣ | 0..1 | Identifier | Unique Identifier for the set of documents |
| identifier | SΣ | 0..* | Identifier | Other identifiers for the manifest |
| status | ?!SΣ | 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: http://terminology.hl7.org/ValueSet/v3-ActCode (example): The activity that caused the DocumentManifest to be created. |
| subject | Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents |
| created | S | 0..1 | dateTime | When this document manifest created |
| author | SΣ | 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 | SΣ | 0..1 | string | Human-readable description (title) |
| content | SΣ | 1..* | Reference(Resource) | Items in manifest |
| related | S | 0..* | BackboneElement | Related things |
| id | 0..1 | id | 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 | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| DocumentManifest.language | preferred | CommonLanguages Max Binding: AllLanguages |
| DocumentManifest.status | required | DocumentReferenceStatus |
| DocumentManifest.type | example | http://terminology.hl7.org/ValueSet/v3-ActCode |
| Id | Path | Details | Requirements |
| dom-2 | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | DocumentManifest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | DocumentManifest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentManifest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentManifest.extension:copyright | 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 | DocumentManifest.extension:copyright | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentManifest.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentManifest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentManifest.masterIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.related | All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters | |
| ele-1 | DocumentManifest.related.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentManifest.related.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentManifest.related.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentManifest.related.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentManifest.related.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentManifest.related.ref | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ Health Level Seven International - SOA Work Group. Package hl7.fhir.uv.fhir-for-fair#0.1.0 based on FHIR 4.1.0. Generated 2021-12-05
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change