Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.virtually.healthcare/StructureDefinition/ServiceRequest | Version: 0.1.0-current | |||
Draft as of 2024-11-06 | Computable Name: ServiceRequest |
Extension of UKCore-ServiceRequest
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | UKCoreServiceRequest | A request for a service to be performed | |
Slices for identifier | S | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Closed by pattern:system |
identifier:CommonResourceIdentifiers | 0..* | CommonResourceIdentifiers | Common Resource Identifiers | |
subject | ||||
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | UKCoreServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
sourceOfServiceRequest | N | 0..1 | CodeableConcept | This represents the source of referral 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 | N | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Details of an additional contact URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact |
coverage | N | 0..1 | CodeableConcept | The funding category 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. |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
Slices for identifier | SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Closed by pattern:system |
identifier:CommonResourceIdentifiers | 0..* | CommonResourceIdentifiers | Common Resource Identifiers | |
basedOn | SΣC | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills ref-1: SHALL have a contained resource if a local reference is provided |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
Slices for category | SΣN | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:coding.system Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
category:genomicsWholeCaseSequencing | ΣN | 0..* | CodeableConcept | Classification of Genomics service Binding: UK Core Genome Sequencing Category (extensible): Classification of the requested service. |
priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
Slices for extension | Content/Rules for all slices | |||
priorityReason | N | 0..* | CodeableConcept | A SNOMED CT concept representing the reason 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. |
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: UK Core Procedure Code (preferred): Codified order entry details which are based on order context. |
subject | SΣC | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for ref-1: SHALL have a contained resource if a local reference is provided |
reference | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
authoredOn | SΣ | 0..1 | dateTime | Date request signed |
requester | SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service ref-1: SHALL have a contained resource if a local reference is provided |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | |
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | |
ServiceRequest.category:genomicsWholeCaseSequencing | extensible | UKCoreGenomeSequencingCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory | |
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | |
ServiceRequest.code | preferred | UKCoreProcedureCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode | |
ServiceRequest.orderDetail | preferred | UKCoreProcedureCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | UKCoreServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
sourceOfServiceRequest | N | 0..1 | CodeableConcept | This represents the source of referral 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 | N | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Details of an additional contact URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact | ||||
coverage | N | 0..1 | CodeableConcept | The funding category 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. | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
Slices for identifier | SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Closed by pattern:system | ||||
identifier:CommonResourceIdentifiers | 0..* | CommonResourceIdentifiers | Common Resource Identifiers | |||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | SΣC | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills ref-1: SHALL have a contained resource if a local reference is provided | ||||
replaces | ΣC | 0..* | Reference(ServiceRequest) | What request replaces ref-1: SHALL have a contained resource if a local reference is provided | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
Slices for category | SΣN | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:coding.system Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
category:genomicsWholeCaseSequencing | ΣN | 0..* | CodeableConcept | Classification of Genomics service Binding: UK Core Genome Sequencing Category (extensible): Classification of the requested service. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
coding | ΣN | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..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 | ||||
priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
priorityReason | N | 0..* | CodeableConcept | A SNOMED CT concept representing the reason 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 | code | Primitive value for code Max Length: 1048576 | |||||
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. | ||||
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: UK Core Procedure Code (preferred): Codified order entry details which are based on order context. | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | SΣC | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
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 | NHSNumbers | An identifier intended for computation | |||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | ΣC | 0..1 | Reference(Encounter) | Encounter in which the request was created ref-1: SHALL have a contained resource if a local reference is provided | ||||
occurrence[x] | Σ | 0..1 | When service should occur | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | ΣC | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer ref-1: SHALL have a contained resource if a local reference is provided | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | ΣC | 0..* | Reference(Location) | Requested location ref-1: SHALL have a contained resource if a local reference is provided | ||||
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: UK Core Service Request Reason Code (preferred): A set of codes that define a reason for a service request. | ||||
reasonReference | ΣC | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service ref-1: SHALL have a contained resource if a local reference is provided | ||||
insurance | C | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage ref-1: SHALL have a contained resource if a local reference is provided | ||||
supportingInfo | C | 0..* | Reference(Resource) | Additional clinical information ref-1: SHALL have a contained resource if a local reference is provided | ||||
specimen | ΣC | 0..* | Reference(Specimen) | Procedure Samples ref-1: SHALL have a contained resource if a local reference is provided | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | C | 0..* | Reference(Provenance) | Request provenance ref-1: SHALL have a contained resource if a local reference is provided | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | ||||
ServiceRequest.category:genomicsWholeCaseSequencing | extensible | UKCoreGenomeSequencingCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | preferred | UKCoreProcedureCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode | ||||
ServiceRequest.orderDetail | preferred | UKCoreProcedureCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode | ||||
ServiceRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role from the FHIR Standard | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | preferred | UKCoreServiceRequestReasonCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode | ||||
ServiceRequest.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
This structure is derived from UKCoreServiceRequest
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from UKCoreServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | UKCoreServiceRequest | A request for a service to be performed | |
Slices for identifier | S | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Closed by pattern:system |
identifier:CommonResourceIdentifiers | 0..* | CommonResourceIdentifiers | Common Resource Identifiers | |
subject | ||||
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | UKCoreServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
sourceOfServiceRequest | N | 0..1 | CodeableConcept | This represents the source of referral 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 | N | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Details of an additional contact URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact |
coverage | N | 0..1 | CodeableConcept | The funding category 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. |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
Slices for identifier | SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Closed by pattern:system |
identifier:CommonResourceIdentifiers | 0..* | CommonResourceIdentifiers | Common Resource Identifiers | |
basedOn | SΣC | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills ref-1: SHALL have a contained resource if a local reference is provided |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
Slices for category | SΣN | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:coding.system Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
category:genomicsWholeCaseSequencing | ΣN | 0..* | CodeableConcept | Classification of Genomics service Binding: UK Core Genome Sequencing Category (extensible): Classification of the requested service. |
priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
Slices for extension | Content/Rules for all slices | |||
priorityReason | N | 0..* | CodeableConcept | A SNOMED CT concept representing the reason 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. |
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: UK Core Procedure Code (preferred): Codified order entry details which are based on order context. |
subject | SΣC | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for ref-1: SHALL have a contained resource if a local reference is provided |
reference | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
authoredOn | SΣ | 0..1 | dateTime | Date request signed |
requester | SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service ref-1: SHALL have a contained resource if a local reference is provided |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | |
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | |
ServiceRequest.category:genomicsWholeCaseSequencing | extensible | UKCoreGenomeSequencingCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory | |
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | |
ServiceRequest.code | preferred | UKCoreProcedureCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode | |
ServiceRequest.orderDetail | preferred | UKCoreProcedureCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | UKCoreServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
sourceOfServiceRequest | N | 0..1 | CodeableConcept | This represents the source of referral 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 | N | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Details of an additional contact URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact | ||||
coverage | N | 0..1 | CodeableConcept | The funding category 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. | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
Slices for identifier | SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Closed by pattern:system | ||||
identifier:CommonResourceIdentifiers | 0..* | CommonResourceIdentifiers | Common Resource Identifiers | |||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | SΣC | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills ref-1: SHALL have a contained resource if a local reference is provided | ||||
replaces | ΣC | 0..* | Reference(ServiceRequest) | What request replaces ref-1: SHALL have a contained resource if a local reference is provided | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
Slices for category | SΣN | 0..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:coding.system Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
category:genomicsWholeCaseSequencing | ΣN | 0..* | CodeableConcept | Classification of Genomics service Binding: UK Core Genome Sequencing Category (extensible): Classification of the requested service. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
coding | ΣN | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..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 | ||||
priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
priorityReason | N | 0..* | CodeableConcept | A SNOMED CT concept representing the reason 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 | code | Primitive value for code Max Length: 1048576 | |||||
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. | ||||
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: UK Core Procedure Code (preferred): Codified order entry details which are based on order context. | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | SΣC | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
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 | NHSNumbers | An identifier intended for computation | |||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | ΣC | 0..1 | Reference(Encounter) | Encounter in which the request was created ref-1: SHALL have a contained resource if a local reference is provided | ||||
occurrence[x] | Σ | 0..1 | When service should occur | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | ΣC | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer ref-1: SHALL have a contained resource if a local reference is provided | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | ΣC | 0..* | Reference(Location) | Requested location ref-1: SHALL have a contained resource if a local reference is provided | ||||
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: UK Core Service Request Reason Code (preferred): A set of codes that define a reason for a service request. | ||||
reasonReference | ΣC | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service ref-1: SHALL have a contained resource if a local reference is provided | ||||
insurance | C | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage ref-1: SHALL have a contained resource if a local reference is provided | ||||
supportingInfo | C | 0..* | Reference(Resource) | Additional clinical information ref-1: SHALL have a contained resource if a local reference is provided | ||||
specimen | ΣC | 0..* | Reference(Specimen) | Procedure Samples ref-1: SHALL have a contained resource if a local reference is provided | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | C | 0..* | Reference(Provenance) | Request provenance ref-1: SHALL have a contained resource if a local reference is provided | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | ||||
ServiceRequest.category:genomicsWholeCaseSequencing | extensible | UKCoreGenomeSequencingCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | preferred | UKCoreProcedureCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode | ||||
ServiceRequest.orderDetail | preferred | UKCoreProcedureCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode | ||||
ServiceRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role from the FHIR Standard | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | preferred | UKCoreServiceRequestReasonCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode | ||||
ServiceRequest.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
This structure is derived from UKCoreServiceRequest
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron