Status: Active: Approved (STU)

Definition: The occurrence of a physical item being requested to be placed or having been placed with a person to aid with support.

Introduction

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. Many of the irrelevant health fields have been stripped from this resource to create a clear and concise model for population.

Coverage and references

• A Data Provider MUST offer FHIR resources that represent its own Equipment Provision.
• When referencing an Equipment Provision resource then the “reference” (URL of FHIR Resource) and “display” (The Equipment type) MUST be populated

Mandatory fields

The following fields are mandatory:

• status the details of what the FHIR statuses represent in the context of social care are listed below;

  • draft – the equipment has been requested but is yet to be placed with the patient
  • active – the equipment has been placed with the patient. It is envisaged that this main remain as active in many cases e.g. where equipment is left with the person permanently
  • cancelled - The person refused the equipment offered.
  • completed - The equipment has been removed and returned to the owner/organisation
  • entered-in-error - The request was placed in error.

• intent Although this field is not relevant to Social Care, it is mandatory within FHIR, therefore we default its value to ‘order’.

• code The type of equipment – categorisation is not required. It is enough to state the exact piece of equipment here. To be taken from the following SNOMED concepts where possible (Preferred Binding)

  • Support Equipment 272243001
  • Assistive Equipment 390296002
  • Equipment to Aid Mobility 183135000

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.

• subject.patient (The person to which the equipment is assigned.)

• authoredOn (The date that the request was created) This may be the same as the occurrence.period.start if the equipment is placed without prior notice/request.

Must Support fields

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.

Optional fields

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.

• requester.agent - Optionally provide an 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.

• requester.onBehalfOf - Optionally provide an Organization which the agent is acting on behalf of.

• performer - Option to provide the Practitioner or Organizational Team or Organization, which fitted or placed the equipment with/on the person.

Discouraged or Removed fields

The following fields are not relevant to social care and have been removed.

• definition
• basedOn
• priorRequest
• groupIdentfier
• priority
• context
• performerType
• reasonCode
• reasonReference
• supportingInformation
• relevantHistory

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

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
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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)
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.yhcr.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
definition		0..0
basedOn		0..0
priorRequest		0..0
groupIdentifier		0..0
status	S	1..1	code	draft | active | completed | entered-in-error | cancelled Binding: Interweave Social Care Request Status (required)
intent	S	1..1	CodeableConcept	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: Interweave Social Care Equipment Type (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
subject	S	1..1	Reference(CareConnectPatient1)	The person to which the equipment is assigned.
reference		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
context		0..0
occurrence[x]		0..1	Period	The period during which the equipment was placed with the person.
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.
requester
agent		1..1	Reference(Device | Practitioner | Organization)	The organization or organizationalTeam that requested the equipment be placed with the person.
reference		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
performerType		0..0
performer		0..1	Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService)	The practitioner, organization or organizationalTeam who placed or fitted the equipment with/on the person.
reference		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
reasonCode		0..0
reasonReference		0..0
supportingInfo		0..0
note		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

Terminology Bindings (Differential)

Path	Conformance	ValueSet
DeviceRequest.status	required	Interweave Social Care Request Status
DeviceRequest.code[x]:codeCodeableConcept	preferred	Interweave Social Care Equipment Type

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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (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://yhcr.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: Common Tags (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://yhcr.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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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 (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.yhcr.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
status	?!SΣ	1..1	code	draft | active | completed | entered-in-error | cancelled Binding: Interweave Social Care Request Status (required)
intent	?!SΣ	1..1	CodeableConcept	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: FHIR Device Types (example): Codes for devices that can be requested
codeReference			Reference(Device)
codeCodeableConcept			CodeableConcept
code[x]:codeCodeableConcept	SΣ	0..1	CodeableConcept	Device requested Binding: Interweave Social Care Equipment Type (preferred)
code[x]:codeReference	SΣ	0..1	Reference(Device)	Device requested
subject	SΣ	1..1	Reference(CareConnectPatient1)	The person to which the equipment is assigned.
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]	Σ	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.
performer	Σ	0..1	Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService)	The practitioner, organization or organizationalTeam who placed or fitted the equipment with/on the person.
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
note		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

Terminology Bindings

Path	Conformance	ValueSet / Code
DeviceRequest.meta.security	extensible	All Security Labels
DeviceRequest.meta.tag	example	Common Tags
DeviceRequest.meta.tag:Source	example	Common Tags
DeviceRequest.meta.tag:Provenance	example	Common Tags
DeviceRequest.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
DeviceRequest.identifier:localIdentifier.use	required	IdentifierUse
DeviceRequest.status	required	Interweave Social Care Request Status
DeviceRequest.intent	required	Fixed Value: order
DeviceRequest.code[x]	example	FHIR Device Types
DeviceRequest.code[x]:codeCodeableConcept	preferred	Interweave Social Care Equipment Type

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DeviceRequest	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()

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
id		0..1	string	xml:id (or equivalent in JSON)
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.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
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://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
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://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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.yhcr.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(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	draft | active | completed | entered-in-error | cancelled Binding: Interweave Social Care Request Status (required)
intent	?!SΣ	1..1	CodeableConcept	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: FHIR Device Types (example): Codes for devices that can be requested
codeReference			Reference(Device)
codeCodeableConcept			CodeableConcept
code[x]:codeCodeableConcept	SΣ	0..1	CodeableConcept	Device requested Binding: Interweave Social Care Equipment Type (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
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	xml:id (or equivalent in JSON)
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(CareConnectPatient1)	The person to which the equipment is assigned.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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]	Σ	0..1	Period	The period during which the equipment was placed with the person.
id		0..1	string	xml:id (or equivalent in JSON)
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	BackboneElement	Who/what is requesting diagnostics
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
agent	Σ	1..1	Reference(Device | Practitioner | Organization)	The organization or organizationalTeam that requested the equipment be placed with the person.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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
onBehalfOf	Σ	0..1	Reference(Organization)	Organization agent is acting for
performer	Σ	0..1	Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService)	The practitioner, organization or organizationalTeam who placed or fitted the equipment with/on the person.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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
note		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

Terminology Bindings

Path	Conformance	ValueSet / Code
DeviceRequest.meta.security	extensible	All Security Labels
DeviceRequest.meta.tag	example	Common Tags
DeviceRequest.meta.tag:Source	example	Common Tags
DeviceRequest.meta.tag:Provenance	example	Common Tags
DeviceRequest.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
DeviceRequest.identifier:localIdentifier.use	required	IdentifierUse
DeviceRequest.identifier:localIdentifier.type	extensible	Identifier Type Codes
DeviceRequest.status	required	Interweave Social Care Request Status
DeviceRequest.intent	required	Fixed Value: order
DeviceRequest.code[x]	example	FHIR Device Types
DeviceRequest.code[x]:codeCodeableConcept	preferred	Interweave Social Care Equipment Type

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

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
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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)
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.yhcr.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
definition		0..0
basedOn		0..0
priorRequest		0..0
groupIdentifier		0..0
status	S	1..1	code	draft | active | completed | entered-in-error | cancelled Binding: Interweave Social Care Request Status (required)
intent	S	1..1	CodeableConcept	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: Interweave Social Care Equipment Type (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
subject	S	1..1	Reference(CareConnectPatient1)	The person to which the equipment is assigned.
reference		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
context		0..0
occurrence[x]		0..1	Period	The period during which the equipment was placed with the person.
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.
requester
agent		1..1	Reference(Device | Practitioner | Organization)	The organization or organizationalTeam that requested the equipment be placed with the person.
reference		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
performerType		0..0
performer		0..1	Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService)	The practitioner, organization or organizationalTeam who placed or fitted the equipment with/on the person.
reference		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
reasonCode		0..0
reasonReference		0..0
supportingInfo		0..0
note		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

Terminology Bindings (Differential)

Path	Conformance	ValueSet
DeviceRequest.status	required	Interweave Social Care Request Status
DeviceRequest.code[x]:codeCodeableConcept	preferred	Interweave Social Care Equipment Type

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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (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://yhcr.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: Common Tags (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://yhcr.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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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 (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.yhcr.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
status	?!SΣ	1..1	code	draft | active | completed | entered-in-error | cancelled Binding: Interweave Social Care Request Status (required)
intent	?!SΣ	1..1	CodeableConcept	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: FHIR Device Types (example): Codes for devices that can be requested
codeReference			Reference(Device)
codeCodeableConcept			CodeableConcept
code[x]:codeCodeableConcept	SΣ	0..1	CodeableConcept	Device requested Binding: Interweave Social Care Equipment Type (preferred)
code[x]:codeReference	SΣ	0..1	Reference(Device)	Device requested
subject	SΣ	1..1	Reference(CareConnectPatient1)	The person to which the equipment is assigned.
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]	Σ	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.
performer	Σ	0..1	Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService)	The practitioner, organization or organizationalTeam who placed or fitted the equipment with/on the person.
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
note		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

Terminology Bindings

Path	Conformance	ValueSet / Code
DeviceRequest.meta.security	extensible	All Security Labels
DeviceRequest.meta.tag	example	Common Tags
DeviceRequest.meta.tag:Source	example	Common Tags
DeviceRequest.meta.tag:Provenance	example	Common Tags
DeviceRequest.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
DeviceRequest.identifier:localIdentifier.use	required	IdentifierUse
DeviceRequest.status	required	Interweave Social Care Request Status
DeviceRequest.intent	required	Fixed Value: order
DeviceRequest.code[x]	example	FHIR Device Types
DeviceRequest.code[x]:codeCodeableConcept	preferred	Interweave Social Care Equipment Type

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DeviceRequest	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()

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
id		0..1	string	xml:id (or equivalent in JSON)
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.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
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://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
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://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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.yhcr.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(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	draft | active | completed | entered-in-error | cancelled Binding: Interweave Social Care Request Status (required)
intent	?!SΣ	1..1	CodeableConcept	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: FHIR Device Types (example): Codes for devices that can be requested
codeReference			Reference(Device)
codeCodeableConcept			CodeableConcept
code[x]:codeCodeableConcept	SΣ	0..1	CodeableConcept	Device requested Binding: Interweave Social Care Equipment Type (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
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	xml:id (or equivalent in JSON)
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(CareConnectPatient1)	The person to which the equipment is assigned.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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]	Σ	0..1	Period	The period during which the equipment was placed with the person.
id		0..1	string	xml:id (or equivalent in JSON)
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	BackboneElement	Who/what is requesting diagnostics
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
agent	Σ	1..1	Reference(Device | Practitioner | Organization)	The organization or organizationalTeam that requested the equipment be placed with the person.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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
onBehalfOf	Σ	0..1	Reference(Organization)	Organization agent is acting for
performer	Σ	0..1	Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService)	The practitioner, organization or organizationalTeam who placed or fitted the equipment with/on the person.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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
note		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

Terminology Bindings

Path	Conformance	ValueSet / Code
DeviceRequest.meta.security	extensible	All Security Labels
DeviceRequest.meta.tag	example	Common Tags
DeviceRequest.meta.tag:Source	example	Common Tags
DeviceRequest.meta.tag:Provenance	example	Common Tags
DeviceRequest.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
DeviceRequest.identifier:localIdentifier.use	required	IdentifierUse
DeviceRequest.identifier:localIdentifier.type	extensible	Identifier Type Codes
DeviceRequest.status	required	Interweave Social Care Request Status
DeviceRequest.intent	required	Fixed Value: order
DeviceRequest.code[x]	example	FHIR Device Types
DeviceRequest.code[x]:codeCodeableConcept	preferred	Interweave Social Care Equipment Type

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

This structure is derived from DeviceRequest

Summary

Mandatory: 4 elements (15 nested mandatory elements)
Must-Support: 21 elements
Fixed Value: 4 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

• CareConnectPatient1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1)

Slices

This structure defines the following Slices:

• The element DeviceRequest.meta.tag is sliced based on the value of value:system
• The element DeviceRequest.identifier is sliced based on the value of value:system
• The element DeviceRequest.code[x] is sliced based on the value of type:$this