NHS Notify – FHIR Letter Printing Implementation Guide
0.1.0 - ci-build
United Kingdom
NHS Notify – FHIR Letter Printing Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://nhsdigital.github.io/nhs-notify-standards/fhir/docs/StructureDefinition/nhsnotify-letter-communicationrequest | Version: 0.1.0 | |||
Draft as of 2025-09-30 | Computable Name: LetterCommunicationRequest | |||
Copyright/Legal: © 2025+ NHS England. Licensed under CC-BY-4.0. |
Request to print and post a patient letter.
Defines the structure of a letter submission request to NHS Notify print-and-post service.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CommunicationRequest
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() ![]() |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Message category Binding: https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category (example) |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Focus of message |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | NHS Number used to identify the patient |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | |
![]() ![]() ![]() |
S | 1..* | BackboneElement | At least one letter payload (PDF metadata via DocumentReference) |
![]() ![]() ![]() ![]() |
1..1 | Reference(Resource) | Message part content Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Letter PDF Document) | DocumentReference wrapping the PDF binary |
![]() ![]() ![]() |
S | 0..1 | dateTime | When the request was authored |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Submitting system or responsible party |
![]() ![]() ![]() |
S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Intended recipient entity (e.g. print fulfilment endpoint) |
![]() ![]() ![]() |
S | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Source organization (ODS code) |
![]() |
Path | Conformance | ValueSet | URI |
CommunicationRequest.category | example | https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-categoryhttps://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Message category Binding: https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category (example) |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Focus of message |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | NHS Number used to identify the patient |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
![]() ![]() ![]() |
S | 1..* | BackboneElement | At least one letter payload (PDF metadata via DocumentReference) |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Reference(Resource) | Message part content Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Letter PDF Document) | DocumentReference wrapping the PDF binary |
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the request was authored |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Submitting system or responsible party |
![]() ![]() ![]() |
S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Intended recipient entity (e.g. print fulfilment endpoint) |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Source organization (ODS code) |
![]() |
Path | Conformance | ValueSet | URI |
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | |
CommunicationRequest.category | example | https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-categoryhttps://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category | |
CommunicationRequest.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | 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 | CommunicationRequest | 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 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | 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() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Message category Binding: https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category (example) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Focus of message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | NHS Number used to identify the patient | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | At least one letter payload (PDF metadata via DocumentReference) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Resource) | Message part content Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Letter PDF Document) | DocumentReference wrapping the PDF binary | ||||
![]() ![]() ![]() |
Σ | 0..1 | When scheduled | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the request was authored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Submitting system or responsible party | ||||
![]() ![]() ![]() |
S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Intended recipient entity (e.g. print fulfilment endpoint) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Source organization (ODS code) | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about communication request | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
CommunicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard
| ||||
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.statusReason | example | |||||
CommunicationRequest.category | example | https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-categoryhttps://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category | ||||
CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
CommunicationRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | 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 | CommunicationRequest | 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 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | 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 CommunicationRequest
Summary
Mandatory: 5 elements
Must-Support: 10 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CommunicationRequest
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() ![]() |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Message category Binding: https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category (example) |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Focus of message |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | NHS Number used to identify the patient |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | |
![]() ![]() ![]() |
S | 1..* | BackboneElement | At least one letter payload (PDF metadata via DocumentReference) |
![]() ![]() ![]() ![]() |
1..1 | Reference(Resource) | Message part content Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Letter PDF Document) | DocumentReference wrapping the PDF binary |
![]() ![]() ![]() |
S | 0..1 | dateTime | When the request was authored |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Submitting system or responsible party |
![]() ![]() ![]() |
S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Intended recipient entity (e.g. print fulfilment endpoint) |
![]() ![]() ![]() |
S | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Source organization (ODS code) |
![]() |
Path | Conformance | ValueSet | URI |
CommunicationRequest.category | example | https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-categoryhttps://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Message category Binding: https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category (example) |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Focus of message |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | NHS Number used to identify the patient |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
![]() ![]() ![]() |
S | 1..* | BackboneElement | At least one letter payload (PDF metadata via DocumentReference) |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Reference(Resource) | Message part content Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Letter PDF Document) | DocumentReference wrapping the PDF binary |
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the request was authored |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Submitting system or responsible party |
![]() ![]() ![]() |
S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Intended recipient entity (e.g. print fulfilment endpoint) |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Source organization (ODS code) |
![]() |
Path | Conformance | ValueSet | URI |
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | |
CommunicationRequest.category | example | https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-categoryhttps://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category | |
CommunicationRequest.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | 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 | CommunicationRequest | 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 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | 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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Message category Binding: https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category (example) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Focus of message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | NHS Number used to identify the patient | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | At least one letter payload (PDF metadata via DocumentReference) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Resource) | Message part content Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Letter PDF Document) | DocumentReference wrapping the PDF binary | ||||
![]() ![]() ![]() |
Σ | 0..1 | When scheduled | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the request was authored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Submitting system or responsible party | ||||
![]() ![]() ![]() |
S | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Intended recipient entity (e.g. print fulfilment endpoint) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Source organization (ODS code) | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about communication request | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
CommunicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard
| ||||
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.statusReason | example | |||||
CommunicationRequest.category | example | https://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-categoryhttps://nhsdigital.github.io/nhs-notify-standards/fhir/ValueSet/nhsnotify-letter-category | ||||
CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
CommunicationRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | 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 | CommunicationRequest | 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 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | 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 CommunicationRequest
Summary
Mandatory: 5 elements
Must-Support: 10 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron