Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
Official URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-SocialCareEquipmentProvision | Version: 0.0.1 | |||
Draft as of 2024-07-15 | Computable Name: InterweaveSocialCareEquipmentProvision |
Interweave Social Care Equipment Provision resource profile (modelled using FHIR DeviceRequest) - DRAFT
Status: DRAFT: For Review
Definition: The occurrence of a physical item being requested to be placed or having been placed with a person to aid with support.
This profile sets minimum expectations for the Social Care Equipment Provision resource to record Information about an occurrence of a physical item being requested to be placed, or having been placed, with or on a person, to aid with support. We use the DeviceRequest structure definition as a base to this profile. Many of the irrelevant health fields have been stripped from this resource to create a clear and concise model for population.
The following fields are mandatory:
status - The details of what the FHIR statuses represent in the context of social care are listed below;
intent - Although this field is not relevant to Social Care, it is mandatory within FHIR, therefore we default its value to 'order'.
codeCodeableConcept - To be taken from the following SNOMED concepts where possible (Preferred Binding)
If it is not possible to use the concepts above, please get in touch. We can either look at extending the valueset, or approve the use of local codes where appropriate.
codeReference - Reference to the Device resource that has been requested. if provided then the "reference" (URL of FHIR Resource) and "display" MUST be populated.
subject - The person to which the equipment is assigned. Each request must be linked to a patient resource.
In addition, the following fields are "Must Support" - i.e. they must be populated if relevant and known:
occurrence.period - period.start should be populated with the date when the person received the equipment. period.end should be populated with the date when the person returned the equipment. It is envisaged that the end date may never be populated in some cases, when a piece of equipment is placed with a person indefinitely.
note - Most equipment will be where the patient lives or on the person, where this is not the case, the notes field can be used to detail exceptions to this rule e.g. aid placed at daughter's house. Although this field will not normally be relevant – if it is then it will be important to populate.
These fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them:
identifier:localIdentifier - As with most other resources, there is the option to include a local identifier which may help to identify the record at a local level.
encounter - An optional reference to encounter that provides additional context in which this request is made.
requester - Optionally provide an Practitioner, Organization or OrganizationalTeam which has requested the equipment to be placed with the person. e.g. The External Organization or an Internal Team who placed the request.
performer - Option to provide the Practitioner or Organizational Team or Organization, which fitted or placed the equipment with/on the person.
reasonCode - Reason or justification for the use of this device.
The following fields are not relevant to social care and have been removed.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DeviceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | 0..* | DeviceRequest | Medical device request | |
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
id | 0..0 | |||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | |
version | 0..0 | |||
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | |
version | 0..0 | |||
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
Slices for identifier | 0..* | Identifier | External Request identifier Slice: Unordered, Open by value:system | |
identifier:localIdentifier | 0..1 | Identifier | External Request identifier | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcareequipmentrequest-identifier |
value | S | 1..1 | string | The Local socialcareequipmentrequest Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique |
period | 0..0 | |||
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | 0..0 | |||
priorRequest | 0..0 | |||
groupIdentifier | 0..0 | |||
status | S | 1..1 | code | draft | active | completed | entered-in-error | cancelled Binding: InterweaveSocialCareDeviceRequestStatus (required) |
intent | S | 1..1 | code | Not important to social care, but is mandated by FHIR, so we default to 'order' Fixed Value: order |
priority | 0..0 | |||
Slices for code[x] | S | 1..1 | Reference(Device), CodeableConcept | Device requested Slice: Unordered, Open by type:$this |
code[x]:codeCodeableConcept | S | 0..1 | CodeableConcept | Device requested Binding: InterweaveSocialCareEquipmentType (preferred) |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
code[x]:codeReference | S | 0..1 | Reference(Device) | Device requested |
parameter | 0..0 | |||
subject | S | 1..1 | Reference(InterweavePatient) | The person to which the equipment is assigned. |
id | 0..0 | |||
extension | 0..0 | |||
reference | 1..1 | string | Reference to a resource (could be Contained) | |
type | 0..0 | |||
identifier | 0..1 | Identifier | If relevant could include an id | |
display | 1..1 | string | Description of the referenced resource | |
encounter | 0..0 | |||
occurrence[x] | S | 0..1 | Period | The period during which the equipment was placed with the person. |
id | 0..0 | |||
start | S | 0..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
authoredOn | S | 1..1 | dateTime | The date that the request was created, this may be the same as the occurrence.period.start, if the equipment is placed without prior request. |
performerType | 0..0 | |||
reasonCode | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (preferred) | |
reasonReference | 0..0 | |||
insurance | 0..0 | |||
supportingInfo | 0..0 | |||
note | S | 0..* | Annotation | Most equipment will be where the patient lives or on the person, where this is not the case, the notes field can be used to detail exceptions. |
relevantHistory | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
DeviceRequest.status | required | InterweaveSocialCareDeviceRequestStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareDeviceRequestStatus from this IG | |
DeviceRequest.code[x]:codeCodeableConcept | preferred | InterweaveSocialCareEquipmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareEquipmentType from this IG | |
DeviceRequest.reasonCode | preferred | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DeviceRequest | 0..* | DeviceRequest | Medical device request | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | External Request identifier Slice: Unordered, Open by value:system | ||||
identifier:localIdentifier | Σ | 0..1 | Identifier | External Request identifier | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcareequipmentrequest-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcareequipmentrequest Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | draft | active | completed | entered-in-error | cancelled Binding: InterweaveSocialCareDeviceRequestStatus (required) | ||||
intent | ?!SΣ | 1..1 | code | Not important to social care, but is mandated by FHIR, so we default to 'order' Binding: RequestIntent (required): The kind of diagnostic request. Fixed Value: order | ||||
Slices for code[x] | SΣ | 1..1 | Device requested Slice: Unordered, Closed by type:$this Binding: FHIRDeviceTypes (example): Codes for devices that can be requested. | |||||
codeReference | Reference(Device) | |||||||
codeCodeableConcept | CodeableConcept | |||||||
code[x]:codeCodeableConcept | SΣ | 0..1 | CodeableConcept | Device requested Binding: InterweaveSocialCareEquipmentType (preferred) | ||||
code[x]:codeReference | SΣ | 0..1 | Reference(Device) | Device requested | ||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | The person to which the equipment is assigned. | ||||
extension | 0..0 | |||||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
occurrence[x] | SΣ | 0..1 | Period | The period during which the equipment was placed with the person. | ||||
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
authoredOn | SΣ | 1..1 | dateTime | The date that the request was created, this may be the same as the occurrence.period.start, if the equipment is placed without prior request. | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (preferred) | ||||
note | S | 0..* | Annotation | Most equipment will be where the patient lives or on the person, where this is not the case, the notes field can be used to detail exceptions. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
DeviceRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DeviceRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DeviceRequest.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DeviceRequest.status | required | InterweaveSocialCareDeviceRequestStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareDeviceRequestStatus from this IG | ||||
DeviceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
DeviceRequest.code[x] | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard | ||||
DeviceRequest.code[x]:codeCodeableConcept | preferred | InterweaveSocialCareEquipmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareEquipmentType from this IG | ||||
DeviceRequest.reasonCode | preferred | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DeviceRequest | 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 | DeviceRequest | 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 | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DeviceRequest | 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 | ||||
---|---|---|---|---|---|---|---|---|
DeviceRequest | 0..* | DeviceRequest | Medical device request | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | External Request identifier Slice: Unordered, Open by value:system | ||||
identifier:localIdentifier | Σ | 0..1 | Identifier | External Request identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 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. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcareequipmentrequest-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcareequipmentrequest Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | draft | active | completed | entered-in-error | cancelled Binding: InterweaveSocialCareDeviceRequestStatus (required) | ||||
intent | ?!SΣ | 1..1 | code | Not important to social care, but is mandated by FHIR, so we default to 'order' Binding: RequestIntent (required): The kind of diagnostic request. Fixed Value: order | ||||
Slices for code[x] | SΣ | 1..1 | Device requested Slice: Unordered, Closed by type:$this Binding: FHIRDeviceTypes (example): Codes for devices that can be requested. | |||||
codeReference | Reference(Device) | |||||||
codeCodeableConcept | CodeableConcept | |||||||
code[x]:codeCodeableConcept | SΣ | 0..1 | CodeableConcept | Device requested Binding: InterweaveSocialCareEquipmentType (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
code[x]:codeReference | SΣ | 0..1 | Reference(Device) | Device requested | ||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | The person to which the equipment is assigned. | ||||
extension | 0..0 | |||||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
occurrence[x] | SΣ | 0..1 | Period | The period during which the equipment was placed with the person. | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
authoredOn | SΣ | 1..1 | dateTime | The date that the request was created, this may be the same as the occurrence.period.start, if the equipment is placed without prior request. | ||||
requester | Σ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Organization) | Who/what is requesting diagnostics | ||||
performer | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (preferred) | ||||
note | S | 0..* | Annotation | Most equipment will be where the patient lives or on the person, where this is not the case, the notes field can be used to detail exceptions. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
DeviceRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DeviceRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DeviceRequest.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DeviceRequest.identifier:localIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
DeviceRequest.status | required | InterweaveSocialCareDeviceRequestStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareDeviceRequestStatus from this IG | ||||
DeviceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
DeviceRequest.code[x] | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard | ||||
DeviceRequest.code[x]:codeCodeableConcept | preferred | InterweaveSocialCareEquipmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareEquipmentType from this IG | ||||
DeviceRequest.parameter.code | example | |||||
DeviceRequest.reasonCode | preferred | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DeviceRequest | 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 | DeviceRequest | 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 | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DeviceRequest | 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 DeviceRequest
Summary
Mandatory: 4 elements(11 nested mandatory elements)
Must-Support: 23 elements
Fixed: 4 elements
Prohibited: 23 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from DeviceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | 0..* | DeviceRequest | Medical device request | |
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
id | 0..0 | |||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | |
version | 0..0 | |||
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | |
version | 0..0 | |||
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
Slices for identifier | 0..* | Identifier | External Request identifier Slice: Unordered, Open by value:system | |
identifier:localIdentifier | 0..1 | Identifier | External Request identifier | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcareequipmentrequest-identifier |
value | S | 1..1 | string | The Local socialcareequipmentrequest Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique |
period | 0..0 | |||
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | 0..0 | |||
priorRequest | 0..0 | |||
groupIdentifier | 0..0 | |||
status | S | 1..1 | code | draft | active | completed | entered-in-error | cancelled Binding: InterweaveSocialCareDeviceRequestStatus (required) |
intent | S | 1..1 | code | Not important to social care, but is mandated by FHIR, so we default to 'order' Fixed Value: order |
priority | 0..0 | |||
Slices for code[x] | S | 1..1 | Reference(Device), CodeableConcept | Device requested Slice: Unordered, Open by type:$this |
code[x]:codeCodeableConcept | S | 0..1 | CodeableConcept | Device requested Binding: InterweaveSocialCareEquipmentType (preferred) |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
code[x]:codeReference | S | 0..1 | Reference(Device) | Device requested |
parameter | 0..0 | |||
subject | S | 1..1 | Reference(InterweavePatient) | The person to which the equipment is assigned. |
id | 0..0 | |||
extension | 0..0 | |||
reference | 1..1 | string | Reference to a resource (could be Contained) | |
type | 0..0 | |||
identifier | 0..1 | Identifier | If relevant could include an id | |
display | 1..1 | string | Description of the referenced resource | |
encounter | 0..0 | |||
occurrence[x] | S | 0..1 | Period | The period during which the equipment was placed with the person. |
id | 0..0 | |||
start | S | 0..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
authoredOn | S | 1..1 | dateTime | The date that the request was created, this may be the same as the occurrence.period.start, if the equipment is placed without prior request. |
performerType | 0..0 | |||
reasonCode | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (preferred) | |
reasonReference | 0..0 | |||
insurance | 0..0 | |||
supportingInfo | 0..0 | |||
note | S | 0..* | Annotation | Most equipment will be where the patient lives or on the person, where this is not the case, the notes field can be used to detail exceptions. |
relevantHistory | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
DeviceRequest.status | required | InterweaveSocialCareDeviceRequestStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareDeviceRequestStatus from this IG | |
DeviceRequest.code[x]:codeCodeableConcept | preferred | InterweaveSocialCareEquipmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareEquipmentType from this IG | |
DeviceRequest.reasonCode | preferred | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DeviceRequest | 0..* | DeviceRequest | Medical device request | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | External Request identifier Slice: Unordered, Open by value:system | ||||
identifier:localIdentifier | Σ | 0..1 | Identifier | External Request identifier | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcareequipmentrequest-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcareequipmentrequest Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | draft | active | completed | entered-in-error | cancelled Binding: InterweaveSocialCareDeviceRequestStatus (required) | ||||
intent | ?!SΣ | 1..1 | code | Not important to social care, but is mandated by FHIR, so we default to 'order' Binding: RequestIntent (required): The kind of diagnostic request. Fixed Value: order | ||||
Slices for code[x] | SΣ | 1..1 | Device requested Slice: Unordered, Closed by type:$this Binding: FHIRDeviceTypes (example): Codes for devices that can be requested. | |||||
codeReference | Reference(Device) | |||||||
codeCodeableConcept | CodeableConcept | |||||||
code[x]:codeCodeableConcept | SΣ | 0..1 | CodeableConcept | Device requested Binding: InterweaveSocialCareEquipmentType (preferred) | ||||
code[x]:codeReference | SΣ | 0..1 | Reference(Device) | Device requested | ||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | The person to which the equipment is assigned. | ||||
extension | 0..0 | |||||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
occurrence[x] | SΣ | 0..1 | Period | The period during which the equipment was placed with the person. | ||||
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
authoredOn | SΣ | 1..1 | dateTime | The date that the request was created, this may be the same as the occurrence.period.start, if the equipment is placed without prior request. | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (preferred) | ||||
note | S | 0..* | Annotation | Most equipment will be where the patient lives or on the person, where this is not the case, the notes field can be used to detail exceptions. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
DeviceRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DeviceRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DeviceRequest.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DeviceRequest.status | required | InterweaveSocialCareDeviceRequestStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareDeviceRequestStatus from this IG | ||||
DeviceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
DeviceRequest.code[x] | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard | ||||
DeviceRequest.code[x]:codeCodeableConcept | preferred | InterweaveSocialCareEquipmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareEquipmentType from this IG | ||||
DeviceRequest.reasonCode | preferred | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DeviceRequest | 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 | DeviceRequest | 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 | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DeviceRequest | 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 | ||||
---|---|---|---|---|---|---|---|---|
DeviceRequest | 0..* | DeviceRequest | Medical device request | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | External Request identifier Slice: Unordered, Open by value:system | ||||
identifier:localIdentifier | Σ | 0..1 | Identifier | External Request identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 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. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcareequipmentrequest-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcareequipmentrequest Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | draft | active | completed | entered-in-error | cancelled Binding: InterweaveSocialCareDeviceRequestStatus (required) | ||||
intent | ?!SΣ | 1..1 | code | Not important to social care, but is mandated by FHIR, so we default to 'order' Binding: RequestIntent (required): The kind of diagnostic request. Fixed Value: order | ||||
Slices for code[x] | SΣ | 1..1 | Device requested Slice: Unordered, Closed by type:$this Binding: FHIRDeviceTypes (example): Codes for devices that can be requested. | |||||
codeReference | Reference(Device) | |||||||
codeCodeableConcept | CodeableConcept | |||||||
code[x]:codeCodeableConcept | SΣ | 0..1 | CodeableConcept | Device requested Binding: InterweaveSocialCareEquipmentType (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
code[x]:codeReference | SΣ | 0..1 | Reference(Device) | Device requested | ||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | The person to which the equipment is assigned. | ||||
extension | 0..0 | |||||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
occurrence[x] | SΣ | 0..1 | Period | The period during which the equipment was placed with the person. | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
authoredOn | SΣ | 1..1 | dateTime | The date that the request was created, this may be the same as the occurrence.period.start, if the equipment is placed without prior request. | ||||
requester | Σ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Organization) | Who/what is requesting diagnostics | ||||
performer | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (preferred) | ||||
note | S | 0..* | Annotation | Most equipment will be where the patient lives or on the person, where this is not the case, the notes field can be used to detail exceptions. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
DeviceRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DeviceRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DeviceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DeviceRequest.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DeviceRequest.identifier:localIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
DeviceRequest.status | required | InterweaveSocialCareDeviceRequestStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareDeviceRequestStatus from this IG | ||||
DeviceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
DeviceRequest.code[x] | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard | ||||
DeviceRequest.code[x]:codeCodeableConcept | preferred | InterweaveSocialCareEquipmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareEquipmentType from this IG | ||||
DeviceRequest.parameter.code | example | |||||
DeviceRequest.reasonCode | preferred | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DeviceRequest | 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 | DeviceRequest | 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 | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DeviceRequest | 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 DeviceRequest
Summary
Mandatory: 4 elements(11 nested mandatory elements)
Must-Support: 23 elements
Fixed: 4 elements
Prohibited: 23 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Element name | Change details |
---|---|
identifier:localIdentifier.system |
|
status |
|
intent |
|
code[x]:codeCodeableConcept |
|
requester |
|
performer |
|