Imaging - IHE Radiology (RAD)
0.0.1-current - ci-build United Kingdom flag

Imaging - IHE Radiology (RAD) - Local Development build (v0.0.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: DocumentReference Minimal Document Metadata

Official URL: https://fhir.nhs.uk/England/RAD/StructureDefinition/DocumentReferenceMinimalDocumentMetadata Version: 0.0.1-current
Draft as of 2025-06-10 Computable Name: DocumentReferenceMinimalDocumentMetadata

See IHE MHD Minimal DocumentReference

Documentation only at present - is not currently required in the project.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from MinimalDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
... identifier 1..* Identifier Other identifiers for the document
... type 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Entry Type (required)
... category 0..1 CodeableConcept Categorization of document
Binding: Document Entry Class (required)
... subject 1..1 Reference(Patient) Who/what is the subject of the document
.... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
... author 0..* Reference(Organization | Practitioner) Who and/or what authored the document
.... identifier 0..1 GeneralMedicalPractitionerCode, GeneralMedicalCouncilReferenceNumber, OrganisationCode Logical reference, when literal reference is not known
... context
.... 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)
.... Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:accessionNumber S 1..1 Reference(Radiology ServiceRequest) Related identifiers or resources
...... type S 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: ServiceRequest
...... identifier 1..1 AccessionNumber Logical reference, when literal reference is not known

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.typerequiredDocumentEntryType
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-type
from this IG
DocumentReference.categoryrequiredDocumentEntryClass
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-class
from this IG
DocumentReference.context.facilityTyperequiredFacilityType
https://fhir.nhs.uk/England/RAD/ValueSet/facility-type
from this IG
DocumentReference.context.practiceSettingrequiredSpecialty
https://fhir.nhs.uk/England/RAD/ValueSet/specialty
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
ele-1: All FHIR elements must have a @value or children
... Slices for identifier SΣ 1..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Entry Type (required)
ele-1: All FHIR elements must have a @value or children
... category SΣ 0..1 CodeableConcept Categorization of document
Binding: Document Entry Class (required)
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Patient) Who/what is the subject of the document
ele-1: All FHIR elements must have a @value or children
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
... date SΣ 0..1 instant When this document reference was created
ele-1: All FHIR elements must have a @value or children
... author SΣ 0..* Reference(Organization | Practitioner) Who and/or what authored the document
ele-1: All FHIR elements must have a @value or children
.... identifier Σ 0..1 GeneralMedicalPractitionerCode, GeneralMedicalCouncilReferenceNumber, OrganisationCode Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
... relatesTo SΣC 0..* BackboneElement Relationships to other documents
ele-1: All FHIR elements must have a @value or children
iti-mhd-repl: a DocumetReference replacements needs to relate to a superseded DocumentReference
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


ele-1: All FHIR elements must have a @value or children
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
ele-1: All FHIR elements must have a @value or children
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
... content Σ 1..1 BackboneElement Document referenced
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children
..... contentType Σ 1..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.


ele-1: All FHIR elements must have a @value or children
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
Example General: en-AU
..... url Σ 1..1 url Uri where the data can be found
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/logo-small.png
..... creation SΣ 0..1 dateTime Date attachment was first created
ele-1: All FHIR elements must have a @value or children
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
ele-1: All FHIR elements must have a @value or children
... context Σ 0..1 BackboneElement Clinical context of document
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... period SΣ 0..1 Period Time of service that is being documented
ele-1: All FHIR elements must have a @value or children
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: Facility Type (required)
ele-1: All FHIR elements must have a @value or children
.... practiceSetting S 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: Specialty (required)
ele-1: All FHIR elements must have a @value or children
.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
ele-1: All FHIR elements must have a @value or children
.... Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
ele-1: All FHIR elements must have a @value or children
..... related:accessionNumber S 1..1 Reference(Radiology ServiceRequest) Related identifiers or resources
ele-1: All FHIR elements must have a @value or children
...... type SΣ 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).


ele-1: All FHIR elements must have a @value or children
Required Pattern: ServiceRequest
...... identifier Σ 1..1 AccessionNumber Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.typerequiredDocumentEntryType
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-type
from this IG
DocumentReference.categoryrequiredDocumentEntryClass
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-class
from this IG
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.facilityTyperequiredFacilityType
https://fhir.nhs.uk/England/RAD/ValueSet/facility-type
from this IG
DocumentReference.context.practiceSettingrequiredSpecialty
https://fhir.nhs.uk/England/RAD/ValueSet/specialty
from this IG
DocumentReference.context.related:accessionNumber.typeextensiblePattern: ServiceRequest
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier SΣ 1..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Entry Type (required)
... category SΣ 0..1 CodeableConcept Categorization of document
Binding: Document Entry Class (required)
... subject SΣ 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 NHSNumber Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date SΣ 0..1 instant When this document reference was created
... author SΣ 0..* Reference(Organization | Practitioner) 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 GeneralMedicalPractitionerCode, GeneralMedicalCouncilReferenceNumber, 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
... relatesTo SΣC 0..* BackboneElement Relationships to other documents
iti-mhd-repl: a DocumetReference replacements needs to relate to a superseded DocumentReference
.... 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 SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..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 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 Σ 1..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 SΣ 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
..... url Σ 1..1 url Uri where the data can be found
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 SΣ 0..1 dateTime Date attachment was first created
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... 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 SΣ 0..1 Period Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: Facility Type (required)
.... practiceSetting S 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: Specialty (required)
.... sourcePatientInfo S 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 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:accessionNumber S 1..1 Reference(Radiology ServiceRequest) Related identifiers or resources
...... 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 SΣ 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: ServiceRequest
...... identifier Σ 1..1 AccessionNumber Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.typerequiredDocumentEntryType
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-type
from this IG
DocumentReference.categoryrequiredDocumentEntryClass
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-class
from this IG
DocumentReference.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTyperequiredFacilityType
https://fhir.nhs.uk/England/RAD/ValueSet/facility-type
from this IG
DocumentReference.context.practiceSettingrequiredSpecialty
https://fhir.nhs.uk/England/RAD/ValueSet/specialty
from this IG
DocumentReference.context.sourcePatientInfo.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.context.related:accessionNumber.typeextensiblePattern: ServiceRequest
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Differential View

This structure is derived from MinimalDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
... identifier 1..* Identifier Other identifiers for the document
... type 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Entry Type (required)
... category 0..1 CodeableConcept Categorization of document
Binding: Document Entry Class (required)
... subject 1..1 Reference(Patient) Who/what is the subject of the document
.... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
... author 0..* Reference(Organization | Practitioner) Who and/or what authored the document
.... identifier 0..1 GeneralMedicalPractitionerCode, GeneralMedicalCouncilReferenceNumber, OrganisationCode Logical reference, when literal reference is not known
... context
.... 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)
.... Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:accessionNumber S 1..1 Reference(Radiology ServiceRequest) Related identifiers or resources
...... type S 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: ServiceRequest
...... identifier 1..1 AccessionNumber Logical reference, when literal reference is not known

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.typerequiredDocumentEntryType
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-type
from this IG
DocumentReference.categoryrequiredDocumentEntryClass
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-class
from this IG
DocumentReference.context.facilityTyperequiredFacilityType
https://fhir.nhs.uk/England/RAD/ValueSet/facility-type
from this IG
DocumentReference.context.practiceSettingrequiredSpecialty
https://fhir.nhs.uk/England/RAD/ValueSet/specialty
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
ele-1: All FHIR elements must have a @value or children
... Slices for identifier SΣ 1..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Entry Type (required)
ele-1: All FHIR elements must have a @value or children
... category SΣ 0..1 CodeableConcept Categorization of document
Binding: Document Entry Class (required)
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Patient) Who/what is the subject of the document
ele-1: All FHIR elements must have a @value or children
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
... date SΣ 0..1 instant When this document reference was created
ele-1: All FHIR elements must have a @value or children
... author SΣ 0..* Reference(Organization | Practitioner) Who and/or what authored the document
ele-1: All FHIR elements must have a @value or children
.... identifier Σ 0..1 GeneralMedicalPractitionerCode, GeneralMedicalCouncilReferenceNumber, OrganisationCode Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
... relatesTo SΣC 0..* BackboneElement Relationships to other documents
ele-1: All FHIR elements must have a @value or children
iti-mhd-repl: a DocumetReference replacements needs to relate to a superseded DocumentReference
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


ele-1: All FHIR elements must have a @value or children
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
ele-1: All FHIR elements must have a @value or children
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
... content Σ 1..1 BackboneElement Document referenced
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children
..... contentType Σ 1..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.


ele-1: All FHIR elements must have a @value or children
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
Example General: en-AU
..... url Σ 1..1 url Uri where the data can be found
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/logo-small.png
..... creation SΣ 0..1 dateTime Date attachment was first created
ele-1: All FHIR elements must have a @value or children
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
ele-1: All FHIR elements must have a @value or children
... context Σ 0..1 BackboneElement Clinical context of document
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... period SΣ 0..1 Period Time of service that is being documented
ele-1: All FHIR elements must have a @value or children
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: Facility Type (required)
ele-1: All FHIR elements must have a @value or children
.... practiceSetting S 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: Specialty (required)
ele-1: All FHIR elements must have a @value or children
.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
ele-1: All FHIR elements must have a @value or children
.... Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
ele-1: All FHIR elements must have a @value or children
..... related:accessionNumber S 1..1 Reference(Radiology ServiceRequest) Related identifiers or resources
ele-1: All FHIR elements must have a @value or children
...... type SΣ 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).


ele-1: All FHIR elements must have a @value or children
Required Pattern: ServiceRequest
...... identifier Σ 1..1 AccessionNumber Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.typerequiredDocumentEntryType
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-type
from this IG
DocumentReference.categoryrequiredDocumentEntryClass
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-class
from this IG
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.facilityTyperequiredFacilityType
https://fhir.nhs.uk/England/RAD/ValueSet/facility-type
from this IG
DocumentReference.context.practiceSettingrequiredSpecialty
https://fhir.nhs.uk/England/RAD/ValueSet/specialty
from this IG
DocumentReference.context.related:accessionNumber.typeextensiblePattern: ServiceRequest
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier SΣ 1..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Entry Type (required)
... category SΣ 0..1 CodeableConcept Categorization of document
Binding: Document Entry Class (required)
... subject SΣ 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 NHSNumber Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date SΣ 0..1 instant When this document reference was created
... author SΣ 0..* Reference(Organization | Practitioner) 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 GeneralMedicalPractitionerCode, GeneralMedicalCouncilReferenceNumber, 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
... relatesTo SΣC 0..* BackboneElement Relationships to other documents
iti-mhd-repl: a DocumetReference replacements needs to relate to a superseded DocumentReference
.... 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 SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..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 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 Σ 1..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 SΣ 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
..... url Σ 1..1 url Uri where the data can be found
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 SΣ 0..1 dateTime Date attachment was first created
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... 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 SΣ 0..1 Period Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: Facility Type (required)
.... practiceSetting S 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: Specialty (required)
.... sourcePatientInfo S 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 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by pattern:type
..... related:accessionNumber S 1..1 Reference(Radiology ServiceRequest) Related identifiers or resources
...... 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 SΣ 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: ServiceRequest
...... identifier Σ 1..1 AccessionNumber Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.typerequiredDocumentEntryType
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-type
from this IG
DocumentReference.categoryrequiredDocumentEntryClass
https://fhir.nhs.uk/England/RAD/ValueSet/document-entry-class
from this IG
DocumentReference.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTyperequiredFacilityType
https://fhir.nhs.uk/England/RAD/ValueSet/facility-type
from this IG
DocumentReference.context.practiceSettingrequiredSpecialty
https://fhir.nhs.uk/England/RAD/ValueSet/specialty
from this IG
DocumentReference.context.sourcePatientInfo.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.context.related:accessionNumber.typeextensiblePattern: ServiceRequest
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron