Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: InterweaveSocialCareContact

Official URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-SocialCareContact Version: 0.0.1
Draft as of 2024-07-15 Computable Name: InterweaveSocialCareContact

Interweave SocialCare Contact resource profile (modelled using UK Core ServiceRequest)- DRAFT.

Usage:

Formal Views of Profile Content

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

This structure is derived from UKCoreServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest UKCoreServiceRequest
... 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
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... requesterType S 1..1 CodeableConcept Social Care Requester Type
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... Slices for identifier 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1 Identifier Identifiers assigned to this order
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcarecontact-identifier
..... value S 1..1 string The Local socialcarecontact 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
... replaces 0..0
... requisition 0..0
... status 1..1 code A mandatory flag to indicate the status of the contact.
Binding: InterweaveSocialCareContactStatus (required)
... intent 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Fixed Value: plan
... category 0..0
... Slices for category Content/Rules for all slices
.... category:genomicsWholeCaseSequencing 0..0
... priority 0..1 code The priority for the contact being acted upon/followed up.
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1 Reference(InterweavePatient) The person which is subject of the contact.
.... 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
... encounter 0..1 Reference(InterweaveEncounter) Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] S 1..1 dateTime The date/time that the contact was made.
... asNeeded[x] 0..0
... authoredOn 1..1 dateTime The date/time that the contact was recorded.
... locationCode 0..0
... locationReference 0..0
... reasonCode S 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: InterweaveSocialCareContactReason (required)
.... 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
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... note 0..0
... relevantHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.statusrequiredInterweaveSocialCareContactStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactStatus
from this IG
ServiceRequest.reasonCoderequiredInterweaveSocialCareContactReason
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactReason
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* UKCoreServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... 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
... 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 extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.


.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.


.... requesterType S 1..1 CodeableConcept Social Care Requester Type
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:localIdentifier Σ 0..1 Identifier Identifiers assigned to this order
..... 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-socialcarecontact-identifier
..... value SΣ 1..1 string The Local socialcarecontact 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 A mandatory flag to indicate the status of the contact.
Binding: InterweaveSocialCareContactStatus (required)
... intent ?!SΣ 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Binding: RequestIntent (required): The kind of service request.


Fixed Value: plan
... priority SΣ 0..1 code The priority for the contact being acted upon/followed up.
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... Slices for extension Content/Rules for all slices
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... subject SΣ 1..1 Reference(InterweavePatient) The person which is subject of the contact.
.... 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
... encounter Σ 0..1 Reference(InterweaveEncounter) Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] SΣ 1..1 dateTime The date/time that the contact was made.
... authoredOn SΣ 1..1 dateTime The date/time that the contact was recorded.
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the service
... reasonCode SΣ 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: InterweaveSocialCareContactReason (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.identifier:localIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ServiceRequest.statusrequiredInterweaveSocialCareContactStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactStatus
from this IG
ServiceRequest.intentrequiredFixed Value: plan
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.reasonCoderequiredInterweaveSocialCareContactReason
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactReason
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* UKCoreServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... 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
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.


.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.


.... requesterType S 1..1 CodeableConcept Social Care Requester Type
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:localIdentifier Σ 0..1 Identifier Identifiers assigned to this order
..... 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-socialcarecontact-identifier
..... value SΣ 1..1 string The Local socialcarecontact 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 A mandatory flag to indicate the status of the contact.
Binding: InterweaveSocialCareContactStatus (required)
... intent ?!SΣ 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Binding: RequestIntent (required): The kind of service request.


Fixed Value: plan
... priority SΣ 0..1 code The priority for the contact being acted upon/followed up.
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


.... value 0..1 string Primitive value for code
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... subject SΣ 1..1 Reference(InterweavePatient) The person which is subject of the contact.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... encounter Σ 0..1 Reference(InterweaveEncounter) Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] SΣ 1..1 dateTime The date/time that the contact was made.
... authoredOn SΣ 1..1 dateTime The date/time that the contact was recorded.
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the service
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... reasonCode SΣ 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: InterweaveSocialCareContactReason (required)
.... 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
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.identifier:localIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ServiceRequest.identifier:localIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ServiceRequest.statusrequiredInterweaveSocialCareContactStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactStatus
from this IG
ServiceRequest.intentrequiredFixed Value: plan
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.reasonCoderequiredInterweaveSocialCareContactReason
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactReason
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from UKCoreServiceRequest

Summary

Mandatory: 7 elements(11 nested mandatory elements)
Must-Support: 15 elements
Fixed: 4 elements
Prohibited: 25 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.meta.tag
  • The element 1 is sliced based on the value of ServiceRequest.identifier

Differential View

This structure is derived from UKCoreServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest UKCoreServiceRequest
... 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
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... requesterType S 1..1 CodeableConcept Social Care Requester Type
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... Slices for identifier 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1 Identifier Identifiers assigned to this order
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcarecontact-identifier
..... value S 1..1 string The Local socialcarecontact 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
... replaces 0..0
... requisition 0..0
... status 1..1 code A mandatory flag to indicate the status of the contact.
Binding: InterweaveSocialCareContactStatus (required)
... intent 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Fixed Value: plan
... category 0..0
... Slices for category Content/Rules for all slices
.... category:genomicsWholeCaseSequencing 0..0
... priority 0..1 code The priority for the contact being acted upon/followed up.
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1 Reference(InterweavePatient) The person which is subject of the contact.
.... 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
... encounter 0..1 Reference(InterweaveEncounter) Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] S 1..1 dateTime The date/time that the contact was made.
... asNeeded[x] 0..0
... authoredOn 1..1 dateTime The date/time that the contact was recorded.
... locationCode 0..0
... locationReference 0..0
... reasonCode S 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: InterweaveSocialCareContactReason (required)
.... 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
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... note 0..0
... relevantHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.statusrequiredInterweaveSocialCareContactStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactStatus
from this IG
ServiceRequest.reasonCoderequiredInterweaveSocialCareContactReason
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactReason
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* UKCoreServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... 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
... 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 extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.


.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.


.... requesterType S 1..1 CodeableConcept Social Care Requester Type
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:localIdentifier Σ 0..1 Identifier Identifiers assigned to this order
..... 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-socialcarecontact-identifier
..... value SΣ 1..1 string The Local socialcarecontact 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 A mandatory flag to indicate the status of the contact.
Binding: InterweaveSocialCareContactStatus (required)
... intent ?!SΣ 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Binding: RequestIntent (required): The kind of service request.


Fixed Value: plan
... priority SΣ 0..1 code The priority for the contact being acted upon/followed up.
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... Slices for extension Content/Rules for all slices
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... subject SΣ 1..1 Reference(InterweavePatient) The person which is subject of the contact.
.... 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
... encounter Σ 0..1 Reference(InterweaveEncounter) Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] SΣ 1..1 dateTime The date/time that the contact was made.
... authoredOn SΣ 1..1 dateTime The date/time that the contact was recorded.
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the service
... reasonCode SΣ 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: InterweaveSocialCareContactReason (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.identifier:localIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ServiceRequest.statusrequiredInterweaveSocialCareContactStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactStatus
from this IG
ServiceRequest.intentrequiredFixed Value: plan
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.reasonCoderequiredInterweaveSocialCareContactReason
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactReason
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* UKCoreServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... 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
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.


.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.


.... requesterType S 1..1 CodeableConcept Social Care Requester Type
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:localIdentifier Σ 0..1 Identifier Identifiers assigned to this order
..... 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-socialcarecontact-identifier
..... value SΣ 1..1 string The Local socialcarecontact 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 A mandatory flag to indicate the status of the contact.
Binding: InterweaveSocialCareContactStatus (required)
... intent ?!SΣ 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Binding: RequestIntent (required): The kind of service request.


Fixed Value: plan
... priority SΣ 0..1 code The priority for the contact being acted upon/followed up.
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


.... value 0..1 string Primitive value for code
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... subject SΣ 1..1 Reference(InterweavePatient) The person which is subject of the contact.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... encounter Σ 0..1 Reference(InterweaveEncounter) Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] SΣ 1..1 dateTime The date/time that the contact was made.
... authoredOn SΣ 1..1 dateTime The date/time that the contact was recorded.
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the service
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... reasonCode SΣ 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: InterweaveSocialCareContactReason (required)
.... 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
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.identifier:localIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ServiceRequest.identifier:localIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ServiceRequest.statusrequiredInterweaveSocialCareContactStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactStatus
from this IG
ServiceRequest.intentrequiredFixed Value: plan
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.reasonCoderequiredInterweaveSocialCareContactReason
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareContactReason
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from UKCoreServiceRequest

Summary

Mandatory: 7 elements(11 nested mandatory elements)
Must-Support: 15 elements
Fixed: 4 elements
Prohibited: 25 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.meta.tag
  • The element 1 is sliced based on the value of ServiceRequest.identifier

 

Other representations of profile: CSV, Excel, Schematron