Enterprise Imaging (Proof of Concept)
0.1.0 - proof-of-concept
Enterprise Imaging (Proof of Concept)
0.1.0 - proof-of-concept
Enterprise Imaging (Proof of Concept) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.nwgenomics.nhs.uk/Imaging/StructureDefinition/DocumentReference | Version: 0.1.0 | ||||
| Draft as of 2026-11-01 | Computable Name: DocumentReference | ||||
Health Document. Copied from the NW GMSA FHIR IG.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  DocumentReference |
0..* | DocumentReference | A reference to a document | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
1..* | CorrelationIdentifier | Other identifiers for the document | |
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |
| type |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentEntry Type (required) | |
| category |
0..* | CodeableConcept | Categorization of document Binding: DocumentEntry Class (required) | |
  subject |
1..1 | Reference(Patient) | Who/what is the subject of the document | |
  identifier |
0..1 | NHSIdentifier | Logical reference, when literal reference is not known | |
| date |
1..1 | instant | When this document reference was created | |
| author |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Who and/or what authored the document | |
| identifier |
0..1 | PractitionerIdentifier  , OrganisationCode |
Logical reference, when literal reference is not known | |
| content |
1..* | BackboneElement | Document referenced | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| attachment |
1..1 | NWAttachment | Where to access the document | |
 context |
0..1 | BackboneElement | Clinical context of document | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| encounter |
0..1 | Reference(Encounter | EpisodeOfCare) | Context of the document content | |
| identifier |
0..1 | CorrelationIdentifier | Logical reference, when literal reference is not known | |
| event |
0..* | CodeableConcept | The procedure or test code associated with the Accession Number (e.g. NICIP, Genomic Test Directory, etc.) 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: Facility Type (required) | |
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Specialty (required) | |
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |
| identifier |
0..1 | MedicalRecordNumber | Logical reference, when literal reference is not known | |
 Slices for related |
0..* | Reference(Resource) | Related resources. For laboratory and imaging reports, a reference to the DiagnosticReport Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  related:DiagnosticReport |
0..1 | Reference(DiagnosticReport) | The DiagnosticReport this document is a rendering of (laboratory or imaging report) | |
 reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
 type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: DiagnosticReport (extensions allowed) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.type | Base | required | DocumentEntry Type | 📦0.1.0 | This IG |
| DocumentReference.category | Base | required | DocumentEntry Class | 📦0.1.0 | This IG |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.5 |
| DocumentReference.context.facilityType | Base | required | Facility Type | 📦0.1.0 | This IG |
| DocumentReference.context.practiceSetting | Base | required | Specialty | 📦0.1.0 | This IG |
| DocumentReference.context.related:DiagnosticReport.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |
| identifier |
1..* | CorrelationIdentifier | Other identifiers for the document | |
 type |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentEntry Type (required) | |
| category |
0..* | CodeableConcept | Categorization of document Binding: DocumentEntry Class (required) | |
| subject |
1..1 | Reference(Patient) | Who/what is the subject of the document | |
| identifier |
0..1 | NHSIdentifier | Logical reference, when literal reference is not known | |
| date |
1..1 | instant | When this document reference was created | |
| author |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Who and/or what authored the document | |
| identifier |
0..1 | PractitionerIdentifier, OrganisationCode | Logical reference, when literal reference is not known | |
| custodian |
||||
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| content |
||||
| attachment |
1..1 | NWAttachment | Where to access the document | |
| context |
||||
| encounter |
0..1 | Reference(Encounter | EpisodeOfCare) | Context of the document content | |
| identifier |
0..1 | CorrelationIdentifier | Logical reference, when literal reference is not known | |
| event |
0..* | CodeableConcept | The procedure or test code associated with the Accession Number (e.g. NICIP, Genomic Test Directory, etc.) | |
| period |
0..1 | Period | Time of service that is being documented | |
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: Facility Type (required) | |
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Specialty (required) | |
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |
| identifier |
0..1 | MedicalRecordNumber | Logical reference, when literal reference is not known | |
| Slices for related |
0..* | Reference(Resource) | Related resources. For laboratory and imaging reports, a reference to the DiagnosticReport Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| related:DiagnosticReport |
0..1 | Reference(DiagnosticReport) | The DiagnosticReport this document is a rendering of (laboratory or imaging report) | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: DiagnosticReport (extensions allowed) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.type | Base | required | DocumentEntry Type | 📦0.1.0 | This IG |
| DocumentReference.category | Base | required | DocumentEntry Class | 📦0.1.0 | This IG |
| DocumentReference.context.facilityType | Base | required | Facility Type | 📦0.1.0 | This IG |
| DocumentReference.context.practiceSetting | Base | required | Specialty | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| masterIdentifier |
0..1 | Identifier | Master Version Specific Identifier | |||||
| identifier |
1..* | CorrelationIdentifier | Other identifiers for the document | |||||
| 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 | Kind of document (LOINC if possible) Binding: DocumentEntry Type (required) | |||||
| category |
0..* | CodeableConcept | Categorization of document Binding: DocumentEntry Class (required) | |||||
| subject |
1..1 | Reference(Patient) | Who/what is the subject of 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 | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | NHSIdentifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| date |
1..1 | instant | When this document reference was created | |||||
| author |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Who and/or what authored 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 | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | PractitionerIdentifier , OrganisationCode |
Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains 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 | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| 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 | Human-readable description | |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| attachment |
1..1 | NWAttachment | Where to access the document | |||||
| 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..1 | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | CorrelationIdentifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| event |
0..* | CodeableConcept | The procedure or test code associated with the Accession Number (e.g. NICIP, Genomic Test Directory, etc.) 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: Facility Type (required) | |||||
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Specialty (required) | |||||
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | MedicalRecordNumber | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| Slices for related |
0..* | Reference(Resource) | Related resources. For laboratory and imaging reports, a reference to the DiagnosticReport Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| related:DiagnosticReport |
0..1 | Reference(DiagnosticReport) | The DiagnosticReport this document is a rendering of (laboratory or imaging report) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: DiagnosticReport (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| Documentation for this format | ||||||||
| 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 | required | DocumentEntry Type | 📦0.1.0 | This IG |
| DocumentReference.category | Base | required | DocumentEntry Class | 📦0.1.0 | This IG |
| DocumentReference.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DocumentReference.author.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DocumentReference.custodian.type | Base | extensible | ResourceType | 📍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.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.encounter.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.5 |
| DocumentReference.context.facilityType | Base | required | Facility Type | 📦0.1.0 | This IG |
| DocumentReference.context.practiceSetting | Base | required | Specialty | 📦0.1.0 | This IG |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.related:DiagnosticReport.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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
Summary
Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
1..* | CorrelationIdentifier | Other identifiers for the document | |
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |
| type |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentEntry Type (required) | |
| category |
0..* | CodeableConcept | Categorization of document Binding: DocumentEntry Class (required) | |
| subject |
1..1 | Reference(Patient) | Who/what is the subject of the document | |
| identifier |
0..1 | NHSIdentifier | Logical reference, when literal reference is not known | |
| date |
1..1 | instant | When this document reference was created | |
| author |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Who and/or what authored the document | |
| identifier |
0..1 | PractitionerIdentifier , OrganisationCode |
Logical reference, when literal reference is not known | |
| content |
1..* | BackboneElement | Document referenced | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| attachment |
1..1 | NWAttachment | Where to access the document | |
| context |
0..1 | BackboneElement | Clinical context of document | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| encounter |
0..1 | Reference(Encounter | EpisodeOfCare) | Context of the document content | |
| identifier |
0..1 | CorrelationIdentifier | Logical reference, when literal reference is not known | |
| event |
0..* | CodeableConcept | The procedure or test code associated with the Accession Number (e.g. NICIP, Genomic Test Directory, etc.) 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: Facility Type (required) | |
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Specialty (required) | |
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |
| identifier |
0..1 | MedicalRecordNumber | Logical reference, when literal reference is not known | |
| Slices for related |
0..* | Reference(Resource) | Related resources. For laboratory and imaging reports, a reference to the DiagnosticReport Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| related:DiagnosticReport |
0..1 | Reference(DiagnosticReport) | The DiagnosticReport this document is a rendering of (laboratory or imaging report) | |
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: DiagnosticReport (extensions allowed) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.type | Base | required | DocumentEntry Type | 📦0.1.0 | This IG |
| DocumentReference.category | Base | required | DocumentEntry Class | 📦0.1.0 | This IG |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.5 |
| DocumentReference.context.facilityType | Base | required | Facility Type | 📦0.1.0 | This IG |
| DocumentReference.context.practiceSetting | Base | required | Specialty | 📦0.1.0 | This IG |
| DocumentReference.context.related:DiagnosticReport.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |
| identifier |
1..* | CorrelationIdentifier | Other identifiers for the document | |
| type |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentEntry Type (required) | |
| category |
0..* | CodeableConcept | Categorization of document Binding: DocumentEntry Class (required) | |
| subject |
1..1 | Reference(Patient) | Who/what is the subject of the document | |
| identifier |
0..1 | NHSIdentifier | Logical reference, when literal reference is not known | |
| date |
1..1 | instant | When this document reference was created | |
| author |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Who and/or what authored the document | |
| identifier |
0..1 | PractitionerIdentifier, OrganisationCode | Logical reference, when literal reference is not known | |
| custodian |
||||
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| content |
||||
| attachment |
1..1 | NWAttachment | Where to access the document | |
| context |
||||
| encounter |
0..1 | Reference(Encounter | EpisodeOfCare) | Context of the document content | |
| identifier |
0..1 | CorrelationIdentifier | Logical reference, when literal reference is not known | |
| event |
0..* | CodeableConcept | The procedure or test code associated with the Accession Number (e.g. NICIP, Genomic Test Directory, etc.) | |
| period |
0..1 | Period | Time of service that is being documented | |
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: Facility Type (required) | |
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Specialty (required) | |
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |
| identifier |
0..1 | MedicalRecordNumber | Logical reference, when literal reference is not known | |
| Slices for related |
0..* | Reference(Resource) | Related resources. For laboratory and imaging reports, a reference to the DiagnosticReport Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| related:DiagnosticReport |
0..1 | Reference(DiagnosticReport) | The DiagnosticReport this document is a rendering of (laboratory or imaging report) | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: DiagnosticReport (extensions allowed) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.type | Base | required | DocumentEntry Type | 📦0.1.0 | This IG |
| DocumentReference.category | Base | required | DocumentEntry Class | 📦0.1.0 | This IG |
| DocumentReference.context.facilityType | Base | required | Facility Type | 📦0.1.0 | This IG |
| DocumentReference.context.practiceSetting | Base | required | Specialty | 📦0.1.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| masterIdentifier |
0..1 | Identifier | Master Version Specific Identifier | |||||
| identifier |
1..* | CorrelationIdentifier | Other identifiers for the document | |||||
| 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 | Kind of document (LOINC if possible) Binding: DocumentEntry Type (required) | |||||
| category |
0..* | CodeableConcept | Categorization of document Binding: DocumentEntry Class (required) | |||||
| subject |
1..1 | Reference(Patient) | Who/what is the subject of 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 | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | NHSIdentifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| date |
1..1 | instant | When this document reference was created | |||||
| author |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Who and/or what authored 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 | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | PractitionerIdentifier , OrganisationCode |
Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains 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 | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| 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 | Human-readable description | |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| attachment |
1..1 | NWAttachment | Where to access the document | |||||
| 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..1 | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | CorrelationIdentifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| event |
0..* | CodeableConcept | The procedure or test code associated with the Accession Number (e.g. NICIP, Genomic Test Directory, etc.) 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: Facility Type (required) | |||||
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Specialty (required) | |||||
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | MedicalRecordNumber | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| Slices for related |
0..* | Reference(Resource) | Related resources. For laboratory and imaging reports, a reference to the DiagnosticReport Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| related:DiagnosticReport |
0..1 | Reference(DiagnosticReport) | The DiagnosticReport this document is a rendering of (laboratory or imaging report) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: DiagnosticReport (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| Documentation for this format | ||||||||
| 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 | required | DocumentEntry Type | 📦0.1.0 | This IG |
| DocumentReference.category | Base | required | DocumentEntry Class | 📦0.1.0 | This IG |
| DocumentReference.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DocumentReference.author.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DocumentReference.custodian.type | Base | extensible | ResourceType | 📍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.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.encounter.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.5 |
| DocumentReference.context.facilityType | Base | required | Facility Type | 📦0.1.0 | This IG |
| DocumentReference.context.practiceSetting | Base | required | Specialty | 📦0.1.0 | This IG |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.related:DiagnosticReport.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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
Summary
Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron