NCPI FHIR Implementation Guide v2
0.2.0 - ci-build

NCPI FHIR Implementation Guide v2 - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NCPI File

Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-file Version: 0.2.0
Draft as of 2025-12-03 Computable Name: NcpiFile

Information about a file related to a research participant

Key Guidelines

The NCPI File profile is based on the standard resource type, DocumentReference and is intended to represent the files associated with a participant in a research study.

Added Profile Restrictions

In order to ensure that our resources are interoperable across studies, we have employed a number of restrictions that should make consuming Patient resources more consistent.

  • participantID should be a globally unique identifier associated with the patient. This practice is intended to make constructing queries for the same patient compatible across different servers (such as QA vs PROD) but also to make the resource URLs more meaningful.

  • fileExternalID should have all appropriate Identifiers with a meaningful system/value pair. Such identifiers may include DbGAP accession IDs, global and external IDs, etc.

  • format and relatedFile.type should use EDAM terminology (i.e., codes) when available. Other file type code systems are allowed if a suitable EDAM code does not exist.

Providing as much information about a file and file metatdata will help individuals using this IG to understand the details and limits of information conveyed about a file.

FHIR Mappings

The following fields from the shared data model are to be mapped to the NCPI File as shown below:

Logical Model Property Cardinality NCPI FHIR Mapping Usage Guidance Notes
participantID 0..1 identifier.value The participant(s) for whom this file contains data  
fileExternalID 0..1 subject A related identifier of this file  
format 1..1 extension[file-format].valueCodeableConcept.coding The file format used  
location 1..* content List of locations where this data can be accessed  
location.uri 1..1 content.attachment.url The URI at which this data can be accessed  
location.accessPolicy 0..* content.extension[location-access].valueReference If present, only those under the specific Access Policy can access the file in this location.  
fileSize 1..1 extension[file-size].valueQuantity.value, extension[file-size].valueQuantity.unit The size of the file, e.g., in bytes.  
hash 0..* extension[hash] Provides a list of hashes for confirming file transfers  
hash.type 0..1 extension[hash-type].valueCode Algorithm used to calculate the hash (and size, where applicable)  
hash.value 1..1 extension[hash-value].valueString Value of hashing the file  
contentVersion 0..1 extension[content-version].valueString Version of the file content  
description 0..1 description A description of the file  
type 1..1 type The type of data contained in this file. Should be as detailed as possible, e.g., Whole Exome Variant Calls.  

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:fileFormat 1..1 CodeableConcept The file format used (EDAM is preferred)
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-format
Binding: Enumerations for the EDAM ontology (extensible)
.... extension:fileSize 1..1 Quantity Indicate the size of the file in reference
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-size
.... extension:hash 0..* (Complex) Provides a list of hashes for confirming file transfers
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/hash-extension
.... extension:contentVersion 0..1 string The version of the content in the file
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/content-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... type Σ 0..1 CodeableConcept The type of data contained in this file.
Binding: Enumerations for the EDAM ontology (extensible)
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) The participant(s) for whom this file contains data (i.e., ParticipantID)
... description Σ 0..1 string A description of the file
... content Σ 1..* BackboneElement Document referenced
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:locationAccess 0..* Reference() If present, only those under the specific Access Policy can access the file in this location.
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/location-access
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... url Σ 1..1 url The URI at which this data can be accessed
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base extensible Enumerations for the EDAM ontology 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:fileFormat 1..1 CodeableConcept The file format used (EDAM is preferred)
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-format
Binding: Enumerations for the EDAM ontology (extensible)
.... extension:fileSize 1..1 Quantity Indicate the size of the file in reference
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-size
.... extension:hash 0..* (Complex) Provides a list of hashes for confirming file transfers
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/hash-extension
.... extension:contentVersion 0..1 string The version of the content in the file
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/content-version
... identifier 0..* Identifier A related external file ID
... type 0..1 CodeableConcept The type of data contained in this file.
Binding: Enumerations for the EDAM ontology (extensible)
... description 0..1 string A description of the file
... content
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:locationAccess 0..* Reference() If present, only those under the specific Access Policy can access the file in this location.
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/location-access
.... attachment
..... url 1..1 url The URI at which this data can be accessed

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.type Base extensible Enumerations for the EDAM ontology 📦0.2.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:fileFormat 1..1 CodeableConcept The file format used (EDAM is preferred)
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-format
Binding: Enumerations for the EDAM ontology (extensible)
.... extension:fileSize 1..1 Quantity Indicate the size of the file in reference
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-size
.... extension:hash 0..* (Complex) Provides a list of hashes for confirming file transfers
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/hash-extension
.... extension:contentVersion 0..1 string The version of the content in the file
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/content-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier A related external file ID
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 0..1 CodeableConcept The type of data contained in this file.
Binding: Enumerations for the EDAM ontology (extensible)
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) The participant(s) for whom this file contains data (i.e., ParticipantID)
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... 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
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string A description of the file
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:locationAccess 0..* Reference() If present, only those under the specific Access Policy can access the file in this location.
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/location-access
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url Σ 1..1 url The URI at which this data can be accessed
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context Σ 0..1 BackboneElement Clinical context of document
.... 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
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base extensible Enumerations for the EDAM ontology 📦0.2.0 This IG
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:fileFormat 1..1 CodeableConcept The file format used (EDAM is preferred)
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-format
Binding: Enumerations for the EDAM ontology (extensible)
.... extension:fileSize 1..1 Quantity Indicate the size of the file in reference
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-size
.... extension:hash 0..* (Complex) Provides a list of hashes for confirming file transfers
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/hash-extension
.... extension:contentVersion 0..1 string The version of the content in the file
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/content-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... type Σ 0..1 CodeableConcept The type of data contained in this file.
Binding: Enumerations for the EDAM ontology (extensible)
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) The participant(s) for whom this file contains data (i.e., ParticipantID)
... description Σ 0..1 string A description of the file
... content Σ 1..* BackboneElement Document referenced
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:locationAccess 0..* Reference() If present, only those under the specific Access Policy can access the file in this location.
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/location-access
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... url Σ 1..1 url The URI at which this data can be accessed
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base extensible Enumerations for the EDAM ontology 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference 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()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:fileFormat 1..1 CodeableConcept The file format used (EDAM is preferred)
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-format
Binding: Enumerations for the EDAM ontology (extensible)
.... extension:fileSize 1..1 Quantity Indicate the size of the file in reference
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-size
.... extension:hash 0..* (Complex) Provides a list of hashes for confirming file transfers
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/hash-extension
.... extension:contentVersion 0..1 string The version of the content in the file
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/content-version
... identifier 0..* Identifier A related external file ID
... type 0..1 CodeableConcept The type of data contained in this file.
Binding: Enumerations for the EDAM ontology (extensible)
... description 0..1 string A description of the file
... content
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:locationAccess 0..* Reference() If present, only those under the specific Access Policy can access the file in this location.
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/location-access
.... attachment
..... url 1..1 url The URI at which this data can be accessed

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.type Base extensible Enumerations for the EDAM ontology 📦0.2.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:fileFormat 1..1 CodeableConcept The file format used (EDAM is preferred)
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-format
Binding: Enumerations for the EDAM ontology (extensible)
.... extension:fileSize 1..1 Quantity Indicate the size of the file in reference
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/file-size
.... extension:hash 0..* (Complex) Provides a list of hashes for confirming file transfers
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/hash-extension
.... extension:contentVersion 0..1 string The version of the content in the file
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/content-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier A related external file ID
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 0..1 CodeableConcept The type of data contained in this file.
Binding: Enumerations for the EDAM ontology (extensible)
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) The participant(s) for whom this file contains data (i.e., ParticipantID)
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... 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
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string A description of the file
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:locationAccess 0..* Reference() If present, only those under the specific Access Policy can access the file in this location.
URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/location-access
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url Σ 1..1 url The URI at which this data can be accessed
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context Σ 0..1 BackboneElement Clinical context of document
.... 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
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base extensible Enumerations for the EDAM ontology 📦0.2.0 This IG
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference 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()

 

Other representations of profile: CSV, Excel, Schematron