with
Command 'link' could not render: Object reference not set to an instance of an object.
DocumentReference | | | DocumentReference | There are no (further) constraints on this element Data type DocumentReference |
identifier | S | | | There are no (further) constraints on this element Element idDocumentReference.identifier |
status | S | | | There are no (further) constraints on this element Element id |
type | S | | Binding | There are no (further) constraints on this element Element idDefinition Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736253002",
"display": "Mental health crisis plan"
}
]
}
Binding NHSDigitalDocumentType (extensible) |
coding | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.type.coding |
system | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.type.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.type.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.type.coding.display |
category | S | | | There are no (further) constraints on this element Element idDocumentReference.category Definition A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
"category": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "734163000",
"display": "Care plan"
}
]
}
]
|
subject | S I | | Reference(Group | Device | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner | NHSDigitalPatient) | There are no (further) constraints on this element Element idDocumentReference.subject Definition A reference to a NHSDigital-Patient and/or an identifier reference using NHSNumber. Only traced NHS Numbers may be used.
"subject": {
"reference": "urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
]
},
Preference is for a reference to a Patient resource, however current document flows may only support limited metadata.
Data type Reference(Group | Device | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner | NHSDigitalPatient) Constraints- patient-reference: subject - An identifier reference or resource reference must be provided
(reference.exists() or (identifier.exists())) - patient-nhs: Supplied NHS Number is outside the English and Welsh NHS Number range or length of the number is wrong.
identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists() and identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').value.matches('^([456789]{1}[0-9]{9})$'))
|
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.subject.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.subject.identifier.value |
date | S | | | There are no (further) constraints on this element Element id |
author | S | | Reference(NHSDigitalOrganization | Device | NHSDigitalPatient | https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson | NHSDigitalPractitionerRole) | There are no (further) constraints on this element Element idDefinition A resource reference to a contained NHSDigital-PractitionerRole
"author": [
{
"reference" : "#author",
}
]
The contained resource:
{
"resourceType": "DocumentReference",
"id": "a9b9f0f4-cc37-4ea3-bd4b-16d15ddbe63b",
"contained": [
{
"resourceType": "PractitionerRole",
"id": "author",
"practitioner": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "0987654321"
}
},
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RR8"
},
"display": "LEEDS TEACHING HOSPITALS NHS TRUST"
}
}
],
Data type Reference(NHSDigitalOrganization | Device | NHSDigitalPatient | https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson | NHSDigitalPractitionerRole) |
custodian | S | | Reference(NHSDigitalOrganization) | There are no (further) constraints on this element Element idDocumentReference.custodian Definition An identifier reference to an ODS Organisation.
"custodian": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "VNE51"
},
"display": "The Pharmacy System"
}
Data type Reference(NHSDigitalOrganization) |
content | S | | | There are no (further) constraints on this element Element idDocumentReference.content Definition The document and format referenced. There may be multiple content element repetitions, each with a different format.
"content": [
{
"attachment": {
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AttachedBy",
"valueReference": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "987654321"
}
}
}
],
"contentType": "application/pdf",
"url": "Binary/att-70001-70002",
"size": 18592,
"title": "upload.png",
"creation": "2022-01-31"
}
}
]
|
attachment | S | | | There are no (further) constraints on this element Element idDocumentReference.content.attachment |
contentType | | | | There are no (further) constraints on this element Element idDocumentReference.content.attachment.contentType Definition A listed of supported document types (mime types) should be provided, this is likely to include:
- FHIR Documents
- PDF
- html
- jpeg/jpg
- png
|
data | S | | | There are no (further) constraints on this element Element idDocumentReference.content.attachment.data Definition SHOULD not be used. Use url to link to the actual document
|
url | S | | | There are no (further) constraints on this element Element idDocumentReference.content.attachment.url Definition For REST interactions this MUST be a url to the actual document. For messaging interactions this must be an internal resource reference to the actual document.
|
context | S | | | There are no (further) constraints on this element Element idDocumentReference.context Definition The clinical context in which the document was prepared.
"context": {
"related" : [
{
"type": "ServiceRequest",
"reference": "ServiceRequest/be735573-9f24-42e1-ae98-af89d632e4bf"
},
{
"type": "Task",
"reference": "Task/f66e4cd7-207c-4b7d-9ac9-80630c451125"
}
]
}
|
practiceSetting | S | | Binding | There are no (further) constraints on this element Element idDocumentReference.context.practiceSetting Definition It is recommended a care setting code should be provided
Binding NHSDigitalCareSettingType (extensible) |
related | S | | Reference(NHSDigitalServiceRequest | NHSDigitalTask) | There are no (further) constraints on this element Element idDocumentReference.context.related Definition Related identifiers or resources associated with the DocumentReference.
In eRS this is used to link a DocumentReference (i.e. a document) to a ServiceRequest and/or Task.
Data type Reference(NHSDigitalServiceRequest | NHSDigitalTask) |
from
Command 'link' could not render: Object reference not set to an instance of an object.
DocumentReference | | | DocumentReference | There are no (further) constraints on this element Data type DocumentReference |
identifier | S | | | There are no (further) constraints on this element Element idDocumentReference.identifier |
status | S | | | There are no (further) constraints on this element Element id |
type | S | | Binding | There are no (further) constraints on this element Element idDefinition Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736253002",
"display": "Mental health crisis plan"
}
]
}
Binding NHSDigitalDocumentType (extensible) |
coding | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.type.coding |
system | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.type.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.type.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.type.coding.display |
category | S | | | There are no (further) constraints on this element Element idDocumentReference.category Definition A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
"category": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "734163000",
"display": "Care plan"
}
]
}
]
|
subject | S I | | Reference(Group | Device | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner | NHSDigitalPatient) | There are no (further) constraints on this element Element idDocumentReference.subject Definition A reference to a NHSDigital-Patient and/or an identifier reference using NHSNumber. Only traced NHS Numbers may be used.
"subject": {
"reference": "urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
]
},
Preference is for a reference to a Patient resource, however current document flows may only support limited metadata.
Data type Reference(Group | Device | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner | NHSDigitalPatient) Constraints- patient-reference: subject - An identifier reference or resource reference must be provided
(reference.exists() or (identifier.exists())) - patient-nhs: Supplied NHS Number is outside the English and Welsh NHS Number range or length of the number is wrong.
identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists() and identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').value.matches('^([456789]{1}[0-9]{9})$'))
|
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.subject.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idDocumentReference.subject.identifier.value |
date | S | | | There are no (further) constraints on this element Element id |
author | S | | Reference(NHSDigitalOrganization | Device | NHSDigitalPatient | https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson | NHSDigitalPractitionerRole) | There are no (further) constraints on this element Element idDefinition A resource reference to a contained NHSDigital-PractitionerRole
"author": [
{
"reference" : "#author",
}
]
The contained resource:
{
"resourceType": "DocumentReference",
"id": "a9b9f0f4-cc37-4ea3-bd4b-16d15ddbe63b",
"contained": [
{
"resourceType": "PractitionerRole",
"id": "author",
"practitioner": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "0987654321"
}
},
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RR8"
},
"display": "LEEDS TEACHING HOSPITALS NHS TRUST"
}
}
],
Data type Reference(NHSDigitalOrganization | Device | NHSDigitalPatient | https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson | NHSDigitalPractitionerRole) |
custodian | S | | Reference(NHSDigitalOrganization) | There are no (further) constraints on this element Element idDocumentReference.custodian Definition An identifier reference to an ODS Organisation.
"custodian": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "VNE51"
},
"display": "The Pharmacy System"
}
Data type Reference(NHSDigitalOrganization) |
content | S | | | There are no (further) constraints on this element Element idDocumentReference.content Definition The document and format referenced. There may be multiple content element repetitions, each with a different format.
"content": [
{
"attachment": {
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AttachedBy",
"valueReference": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "987654321"
}
}
}
],
"contentType": "application/pdf",
"url": "Binary/att-70001-70002",
"size": 18592,
"title": "upload.png",
"creation": "2022-01-31"
}
}
]
|
attachment | S | | | There are no (further) constraints on this element Element idDocumentReference.content.attachment |
contentType | | | | There are no (further) constraints on this element Element idDocumentReference.content.attachment.contentType Definition A listed of supported document types (mime types) should be provided, this is likely to include:
- FHIR Documents
- PDF
- html
- jpeg/jpg
- png
|
data | S | | | There are no (further) constraints on this element Element idDocumentReference.content.attachment.data Definition SHOULD not be used. Use url to link to the actual document
|
url | S | | | There are no (further) constraints on this element Element idDocumentReference.content.attachment.url Definition For REST interactions this MUST be a url to the actual document. For messaging interactions this must be an internal resource reference to the actual document.
|
context | S | | | There are no (further) constraints on this element Element idDocumentReference.context Definition The clinical context in which the document was prepared.
"context": {
"related" : [
{
"type": "ServiceRequest",
"reference": "ServiceRequest/be735573-9f24-42e1-ae98-af89d632e4bf"
},
{
"type": "Task",
"reference": "Task/f66e4cd7-207c-4b7d-9ac9-80630c451125"
}
]
}
|
practiceSetting | S | | Binding | There are no (further) constraints on this element Element idDocumentReference.context.practiceSetting Definition It is recommended a care setting code should be provided
Binding NHSDigitalCareSettingType (extensible) |
related | S | | Reference(NHSDigitalServiceRequest | NHSDigitalTask) | There are no (further) constraints on this element Element idDocumentReference.context.related Definition Related identifiers or resources associated with the DocumentReference.
In eRS this is used to link a DocumentReference (i.e. a document) to a ServiceRequest and/or Task.
Data type Reference(NHSDigitalServiceRequest | NHSDigitalTask) |
Definition
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
Usually, this is used for documents other than those defined by FHIR.
identifier
Definition
Other identifiers associated with the document, including version independent identifiers.
status
Definition
The status of this document reference.
This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.
type
Definition
Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736253002",
"display": "Mental health crisis plan"
}
]
}
Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.
category
Definition
A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
"category": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "734163000",
"display": "Care plan"
}
]
}
]
Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.
subject
Definition
A reference to a NHSDigital-Patient and/or an identifier reference using NHSNumber. Only traced NHS Numbers may be used.
"subject": {
"reference": "urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
]
},
Preference is for a reference to a Patient resource, however current document flows may only support limited metadata.
Constraints
- patient-reference (WARNING) subject - An identifier reference or resource reference must be provided
- patient-nhs (ERROR) Supplied NHS Number is outside the English and Welsh NHS Number range or length of the number is wrong.
date
Definition
When the document reference was created.
Referencing/indexing time is used for tracking, organizing versions and searching.
author
Definition
A resource reference to a contained NHSDigital-PractitionerRole
"author": [
{
"reference" : "#author",
}
]
The contained resource:
{
"resourceType": "DocumentReference",
"id": "a9b9f0f4-cc37-4ea3-bd4b-16d15ddbe63b",
"contained": [
{
"resourceType": "PractitionerRole",
"id": "author",
"practitioner": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "0987654321"
}
},
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RR8"
},
"display": "LEEDS TEACHING HOSPITALS NHS TRUST"
}
}
],
Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).
custodian
Definition
An identifier reference to an ODS Organisation.
"custodian": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "VNE51"
},
"display": "The Pharmacy System"
}
Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.
content
Definition
The document and format referenced. There may be multiple content element repetitions, each with a different format.
"content": [
{
"attachment": {
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AttachedBy",
"valueReference": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "987654321"
}
}
}
],
"contentType": "application/pdf",
"url": "Binary/att-70001-70002",
"size": 18592,
"title": "upload.png",
"creation": "2022-01-31"
}
}
]
content.attachment
Definition
The document or URL of the document along with critical metadata to prove content has integrity.
content.attachment.data
Definition
SHOULD not be used. Use url to link to the actual document
Requirements
The data needs to able to be transmitted inline.
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
content.attachment.url
Definition
For REST interactions this MUST be a url to the actual document. For messaging interactions this must be an internal resource reference to the actual document.
Requirements
The data needs to be transmitted by reference.
If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
context
Definition
The clinical context in which the document was prepared.
"context": {
"related" : [
{
"type": "ServiceRequest",
"reference": "ServiceRequest/be735573-9f24-42e1-ae98-af89d632e4bf"
},
{
"type": "Task",
"reference": "Task/f66e4cd7-207c-4b7d-9ac9-80630c451125"
}
]
}
These values are primarily added to help with searching for interesting/relevant documents.
context.practiceSetting
Definition
It is recommended a care setting code should be provided
Requirements
This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.
This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.
context.related
Definition
Related identifiers or resources associated with the DocumentReference.
In eRS this is used to link a DocumentReference (i.e. a document) to a ServiceRequest and/or Task.
May be identifiers or resources that caused the DocumentReference or referenced Document to be created.