0.1.0 - ci-build

SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SENAITE Service Request

Official URL: https://fhir.senaite.org/StructureDefinition/SenaiteServiceRequest Version: 0.1.0
Draft as of 2026-11-05 Computable Name: SenaiteServiceRequest

This will be an incoming lab request. It relies on references to:

  • Specimen: to handle the related specimen details.
  • Subject: The patient
  • Organization: Determining from which client the request originated.
  • Requester: The practitioner who made the request.

This resource carries no identifier. ServiceRequest.identifier is prohibited (0..0) on both read and write. SENAITE holds no stored ServiceRequest object — a ServiceRequest is POST input within a SenaiteRequestBundle and thereafter a projection over the AnalysisRequest it created. Sample identity belongs to the Sample, and is carried on the resources that represent it: SenaiteSpecimen and SenaiteDiagnosticReport, which hold the internal Sample ID (#usual) and the consumer-owned Client Sample ID (#secondary). A consumer supplying its own reference for one sample puts it on the Specimen entry, not here. The ServiceRequest is addressed by the logical id returned in the transaction response — that is the id supplied to $revoke.

Requisition (Sample Group ID). ServiceRequest.requisition is the one identifier this resource may carry. It groups the ServiceRequests of a single order that is submitted as several SenaiteRequestBundle transactions — normally one per sample type (tube). Its system is fixed by this IG to the Sample Group ID namespace (https://fhir.senaite.org/NamingSystem/sample-group-id); the consumer chooses the value and supplies the same value on every ServiceRequest in the order. It is optional, is a label rather than a contract (the server cannot know that an order is complete), and is not required to be unique per sample. Because the system is shared, the value must be unique within the consumer, and the server scopes searches on it to the Client(s) the caller is authorised for. Each bundle still carries exactly one ServiceRequest and one Specimen. See Sample Group ID and Multi-tube orders.

See Identifiers.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.contained 0..* Resource Contained, inline Resources
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Order grouping identifier, shared by the ServiceRequests of one multi-tube order
ServiceRequest.requisition.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.requisition.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed)
ServiceRequest.requisition.value This element is included in summaries. C 1..1 string Requisition value — alphanumeric and hyphens only
Example General: 123456
ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | entered-in-error
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code order | reflex-order
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
ServiceRequest.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.code This element is included in summaries. C 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
ServiceRequest.code.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.orderDetail This element is included in summaries. C 0..* BackboneElement Additional order information
ServiceRequest.orderDetail.parameter This element is included in summaries. 1..* BackboneElement The parameter details for the service being requested
ServiceRequest.orderDetail.parameter.code This element is included in summaries. 1..1 CodeableConcept The detail of the order being requested
Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code" : "LOINC",
      "display" : "Test Code"
    }
  ]
}
ServiceRequest.orderDetail.parameter.value[x] This element is included in summaries. 1..1 CodeableConcept The value for the order detail
Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests
ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
ServiceRequest.specimen This element is included in summaries. 1..1 Reference(Specimen) Procedure Samples
ServiceRequest.specimen.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍5.0.0 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍5.0.0 FHIR Std.
ServiceRequest.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
ServiceRequest.code Base preferred http://loinc.org Not State Unknown
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.value[x] Base preferred http://loinc.org Not State Unknown

Constraints

Id Grade Path(s) Description Expression
bdystr-1 error ServiceRequest bodyStructure SHALL only be present if bodySite is not present bodySite.exists() implies bodyStructure.empty()
dom-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()
subject-identified error ServiceRequest.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest ServiceRequest
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
ServiceRequest.modifierExtension 0..0 Extension
ServiceRequest.identifier 0..0 Not used — see identifiers.html#sample-identifiers
ServiceRequest.instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri 0..0 Instantiates external protocol or definition
ServiceRequest.basedOn 0..0 What request fulfills
ServiceRequest.replaces 0..0 What request replaces
ServiceRequest.requisition 0..1 Identifier Order grouping identifier, shared by the ServiceRequests of one multi-tube order
ServiceRequest.requisition.extension 0..0 Extension
ServiceRequest.requisition.use 0..0 usual | official | temp | secondary | old (If known)
ServiceRequest.requisition.type 0..0 Description of identifier
ServiceRequest.requisition.system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed)
ServiceRequest.requisition.value 1..1 string Requisition value — alphanumeric and hyphens only
ServiceRequest.requisition.period 0..0 Time period when id is/was valid for use
ServiceRequest.requisition.assigner 0..0 Organization that issued id (may be just text)
ServiceRequest.status 1..1 code draft | active | on-hold | revoked | entered-in-error
ServiceRequest.intent 1..1 code order | reflex-order
Fixed Value: order (no extensions allowed)
ServiceRequest.category 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
ServiceRequest.category.coding
ServiceRequest.category.coding.system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.version 0..0 Version of the system - if relevant
ServiceRequest.category.coding.code 0..1 code Symbol in syntax defined by the system
Fixed Value: 108252007 (no extensions allowed)
ServiceRequest.category.coding.display 0..1 string Representation defined by the system
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.category.coding.userSelected 0..0 If this coding was chosen directly by the user
ServiceRequest.category.text 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.doNotPerform 0..0 True if service/procedure should not be performed
ServiceRequest.code 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
ServiceRequest.code.extension 0..0 Extension
ServiceRequest.orderDetail 0..* BackboneElement Additional order information
ServiceRequest.orderDetail.extension 0..0 Extension
ServiceRequest.orderDetail.modifierExtension 0..0 Extension
ServiceRequest.orderDetail.parameterFocus 0..0 The context of the order details by reference
ServiceRequest.orderDetail.parameter
ServiceRequest.orderDetail.parameter.extension 0..0 Extension
ServiceRequest.orderDetail.parameter.modifierExtension 0..0 Extension
ServiceRequest.orderDetail.parameter.code 1..1 CodeableConcept The detail of the order being requested
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code" : "LOINC",
      "display" : "Test Code"
    }
  ]
}
ServiceRequest.orderDetail.parameter.value[x] 1..1 CodeableConcept The value for the order detail
Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests
ServiceRequest.quantity[x] 0..0 Service amount
ServiceRequest.subject
ServiceRequest.subject.reference C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
ServiceRequest.subject.type 0..0 Type the reference refers to (e.g. "Patient") - must be a resource in resources
ServiceRequest.subject.identifier 0..0 Logical reference, when literal reference is not known
ServiceRequest.encounter 0..0 Encounter in which the request was created
ServiceRequest.occurrence[x] 0..0 When service should occur
ServiceRequest.asNeeded[x] 0..0 Preconditions for service
ServiceRequest.authoredOn 0..0 Date request signed
ServiceRequest.requester
ServiceRequest.requester.extension 0..0 Extension
ServiceRequest.requester.reference 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.requester.type 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Fixed Value: Practitioner (no extensions allowed)
ServiceRequest.requester.identifier 0..0 Logical reference, when literal reference is not known
ServiceRequest.requester.display 0..0 Text alternative for the resource
ServiceRequest.performerType 0..0 Performer role
ServiceRequest.performer 0..0 Requested performer
ServiceRequest.location 0..0 Requested location
ServiceRequest.reason 0..0 Explanation/Justification for procedure or service
ServiceRequest.insurance 0..0 Associated insurance coverage
ServiceRequest.supportingInfo 0..0 Additional clinical information
ServiceRequest.specimen 1..1 Reference(Specimen) Procedure Samples
ServiceRequest.specimen.reference 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.bodySite 0..0 Coded location on Body
ServiceRequest.note
ServiceRequest.note.extension 0..0 Extension
ServiceRequest.note.author[x] 0..0 Individual responsible for the annotation
ServiceRequest.note.time 0..0 When the annotation was made
ServiceRequest.patientInstruction 0..0 Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..0 Request provenance

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
ServiceRequest.code Base preferred http://loinc.org Not State Unknown
ServiceRequest.orderDetail.​parameter.value[x] Base preferred http://loinc.org Not State Unknown

Constraints

Id Grade Path(s) Description Expression
subject-identified error ServiceRequest.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1
ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
ServiceRequest.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ServiceRequest.contained 0..* Resource Contained, inline Resources
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Order grouping identifier, shared by the ServiceRequests of one multi-tube order
ServiceRequest.requisition.id 0..1 id Unique id for inter-element referencing
ServiceRequest.requisition.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.requisition.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed)
ServiceRequest.requisition.value This element is included in summaries. C 1..1 string Requisition value — alphanumeric and hyphens only
Example General: 123456
ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | entered-in-error
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code order | reflex-order
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
ServiceRequest.category.id 0..1 id Unique id for inter-element referencing
ServiceRequest.category.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.category.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
ServiceRequest.category.coding.id 0..1 id Unique id for inter-element referencing
ServiceRequest.category.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.category.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Fixed Value: 108252007 (no extensions allowed)
ServiceRequest.category.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.code This element is included in summaries. C 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
ServiceRequest.code.id 0..1 id Unique id for inter-element referencing
ServiceRequest.code.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.code.concept This element is included in summaries. 0..1 CodeableConcept Reference to a concept (by class)
ServiceRequest.code.reference This element is included in summaries. 0..1 Reference() Reference to a resource (by instance)
ServiceRequest.orderDetail This element is included in summaries. C 0..* BackboneElement Additional order information
ServiceRequest.orderDetail.id 0..1 string Unique id for inter-element referencing
ServiceRequest.orderDetail.parameter This element is included in summaries. 1..* BackboneElement The parameter details for the service being requested
ServiceRequest.orderDetail.parameter.id 0..1 string Unique id for inter-element referencing
ServiceRequest.orderDetail.parameter.code This element is included in summaries. 1..1 CodeableConcept The detail of the order being requested
Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code" : "LOINC",
      "display" : "Test Code"
    }
  ]
}
ServiceRequest.orderDetail.parameter.value[x] This element is included in summaries. 1..1 CodeableConcept The value for the order detail
Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests
ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.subject.id 0..1 id Unique id for inter-element referencing
ServiceRequest.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
ServiceRequest.subject.display This element is included in summaries. C 0..1 string Text alternative for the resource
ServiceRequest.focus This element is included in summaries. 0..* Reference(Resource) What the service request is about, when it is not about the subject of record
ServiceRequest.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ServiceRequest.requester.id 0..1 id Unique id for inter-element referencing
ServiceRequest.requester.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.requester.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.requester.type This element is included in summaries. 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Practitioner (no extensions allowed)
ServiceRequest.specimen This element is included in summaries. 1..1 Reference(Specimen) Procedure Samples
ServiceRequest.specimen.id 0..1 id Unique id for inter-element referencing
ServiceRequest.specimen.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.specimen.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.specimen.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
ServiceRequest.specimen.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.specimen.display This element is included in summaries. C 0..1 string Text alternative for the resource
ServiceRequest.bodyStructure This element is included in summaries. C 0..1 Reference(BodyStructure) BodyStructure-based location on the body
ServiceRequest.note 0..* Annotation Comments
ServiceRequest.note.id 0..1 id Unique id for inter-element referencing
ServiceRequest.note.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.note.text This element is included in summaries. 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base required All Languages 📍5.0.0 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍5.0.0 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍5.0.0 FHIR Std.
ServiceRequest.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
ServiceRequest.priority Base required RequestPriority 📍5.0.0 FHIR Std.
ServiceRequest.code Base preferred http://loinc.org Not State Unknown
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.value[x] Base preferred http://loinc.org Not State Unknown
ServiceRequest.requester.​type Base extensible Resource Types 📍5.0.0 FHIR Std.
ServiceRequest.specimen.​type Base extensible Resource Types 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdystr-1 error ServiceRequest bodyStructure SHALL only be present if bodySite is not present bodySite.exists() implies bodyStructure.empty()
dom-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()
subject-identified error ServiceRequest.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()

This structure is derived from ServiceRequest

Summary

Mandatory: 6 elements(4 nested mandatory elements)
Fixed: 7 elements
Prohibited: 42 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.contained 0..* Resource Contained, inline Resources
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Order grouping identifier, shared by the ServiceRequests of one multi-tube order
ServiceRequest.requisition.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.requisition.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed)
ServiceRequest.requisition.value This element is included in summaries. C 1..1 string Requisition value — alphanumeric and hyphens only
Example General: 123456
ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | entered-in-error
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code order | reflex-order
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
ServiceRequest.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.code This element is included in summaries. C 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
ServiceRequest.code.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.orderDetail This element is included in summaries. C 0..* BackboneElement Additional order information
ServiceRequest.orderDetail.parameter This element is included in summaries. 1..* BackboneElement The parameter details for the service being requested
ServiceRequest.orderDetail.parameter.code This element is included in summaries. 1..1 CodeableConcept The detail of the order being requested
Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code" : "LOINC",
      "display" : "Test Code"
    }
  ]
}
ServiceRequest.orderDetail.parameter.value[x] This element is included in summaries. 1..1 CodeableConcept The value for the order detail
Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests
ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
ServiceRequest.specimen This element is included in summaries. 1..1 Reference(Specimen) Procedure Samples
ServiceRequest.specimen.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍5.0.0 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍5.0.0 FHIR Std.
ServiceRequest.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
ServiceRequest.code Base preferred http://loinc.org Not State Unknown
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.value[x] Base preferred http://loinc.org Not State Unknown

Constraints

Id Grade Path(s) Description Expression
bdystr-1 error ServiceRequest bodyStructure SHALL only be present if bodySite is not present bodySite.exists() implies bodyStructure.empty()
dom-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()
subject-identified error ServiceRequest.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest ServiceRequest
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
ServiceRequest.modifierExtension 0..0 Extension
ServiceRequest.identifier 0..0 Not used — see identifiers.html#sample-identifiers
ServiceRequest.instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri 0..0 Instantiates external protocol or definition
ServiceRequest.basedOn 0..0 What request fulfills
ServiceRequest.replaces 0..0 What request replaces
ServiceRequest.requisition 0..1 Identifier Order grouping identifier, shared by the ServiceRequests of one multi-tube order
ServiceRequest.requisition.extension 0..0 Extension
ServiceRequest.requisition.use 0..0 usual | official | temp | secondary | old (If known)
ServiceRequest.requisition.type 0..0 Description of identifier
ServiceRequest.requisition.system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed)
ServiceRequest.requisition.value 1..1 string Requisition value — alphanumeric and hyphens only
ServiceRequest.requisition.period 0..0 Time period when id is/was valid for use
ServiceRequest.requisition.assigner 0..0 Organization that issued id (may be just text)
ServiceRequest.status 1..1 code draft | active | on-hold | revoked | entered-in-error
ServiceRequest.intent 1..1 code order | reflex-order
Fixed Value: order (no extensions allowed)
ServiceRequest.category 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
ServiceRequest.category.coding
ServiceRequest.category.coding.system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.version 0..0 Version of the system - if relevant
ServiceRequest.category.coding.code 0..1 code Symbol in syntax defined by the system
Fixed Value: 108252007 (no extensions allowed)
ServiceRequest.category.coding.display 0..1 string Representation defined by the system
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.category.coding.userSelected 0..0 If this coding was chosen directly by the user
ServiceRequest.category.text 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.doNotPerform 0..0 True if service/procedure should not be performed
ServiceRequest.code 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
ServiceRequest.code.extension 0..0 Extension
ServiceRequest.orderDetail 0..* BackboneElement Additional order information
ServiceRequest.orderDetail.extension 0..0 Extension
ServiceRequest.orderDetail.modifierExtension 0..0 Extension
ServiceRequest.orderDetail.parameterFocus 0..0 The context of the order details by reference
ServiceRequest.orderDetail.parameter
ServiceRequest.orderDetail.parameter.extension 0..0 Extension
ServiceRequest.orderDetail.parameter.modifierExtension 0..0 Extension
ServiceRequest.orderDetail.parameter.code 1..1 CodeableConcept The detail of the order being requested
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code" : "LOINC",
      "display" : "Test Code"
    }
  ]
}
ServiceRequest.orderDetail.parameter.value[x] 1..1 CodeableConcept The value for the order detail
Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests
ServiceRequest.quantity[x] 0..0 Service amount
ServiceRequest.subject
ServiceRequest.subject.reference C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
ServiceRequest.subject.type 0..0 Type the reference refers to (e.g. "Patient") - must be a resource in resources
ServiceRequest.subject.identifier 0..0 Logical reference, when literal reference is not known
ServiceRequest.encounter 0..0 Encounter in which the request was created
ServiceRequest.occurrence[x] 0..0 When service should occur
ServiceRequest.asNeeded[x] 0..0 Preconditions for service
ServiceRequest.authoredOn 0..0 Date request signed
ServiceRequest.requester
ServiceRequest.requester.extension 0..0 Extension
ServiceRequest.requester.reference 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.requester.type 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Fixed Value: Practitioner (no extensions allowed)
ServiceRequest.requester.identifier 0..0 Logical reference, when literal reference is not known
ServiceRequest.requester.display 0..0 Text alternative for the resource
ServiceRequest.performerType 0..0 Performer role
ServiceRequest.performer 0..0 Requested performer
ServiceRequest.location 0..0 Requested location
ServiceRequest.reason 0..0 Explanation/Justification for procedure or service
ServiceRequest.insurance 0..0 Associated insurance coverage
ServiceRequest.supportingInfo 0..0 Additional clinical information
ServiceRequest.specimen 1..1 Reference(Specimen) Procedure Samples
ServiceRequest.specimen.reference 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.bodySite 0..0 Coded location on Body
ServiceRequest.note
ServiceRequest.note.extension 0..0 Extension
ServiceRequest.note.author[x] 0..0 Individual responsible for the annotation
ServiceRequest.note.time 0..0 When the annotation was made
ServiceRequest.patientInstruction 0..0 Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..0 Request provenance

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
ServiceRequest.code Base preferred http://loinc.org Not State Unknown
ServiceRequest.orderDetail.​parameter.value[x] Base preferred http://loinc.org Not State Unknown

Constraints

Id Grade Path(s) Description Expression
subject-identified error ServiceRequest.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1
ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
ServiceRequest.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ServiceRequest.contained 0..* Resource Contained, inline Resources
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:client 1..1 Reference(SenaiteOrganization) The submitting client organisation
URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Order grouping identifier, shared by the ServiceRequests of one multi-tube order
ServiceRequest.requisition.id 0..1 id Unique id for inter-element referencing
ServiceRequest.requisition.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.requisition.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed)
ServiceRequest.requisition.value This element is included in summaries. C 1..1 string Requisition value — alphanumeric and hyphens only
Example General: 123456
ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | entered-in-error
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code order | reflex-order
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (required): Classification of the requested service.
ServiceRequest.category.id 0..1 id Unique id for inter-element referencing
ServiceRequest.category.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.category.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
ServiceRequest.category.coding.id 0..1 id Unique id for inter-element referencing
ServiceRequest.category.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.category.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Fixed Value: 108252007 (no extensions allowed)
ServiceRequest.category.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
Fixed Value: Laboratory procedure (no extensions allowed)
ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.code This element is included in summaries. C 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: http://loinc.org (preferred): For laboratory codes
ServiceRequest.code.id 0..1 id Unique id for inter-element referencing
ServiceRequest.code.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.code.concept This element is included in summaries. 0..1 CodeableConcept Reference to a concept (by class)
ServiceRequest.code.reference This element is included in summaries. 0..1 Reference() Reference to a resource (by instance)
ServiceRequest.orderDetail This element is included in summaries. C 0..* BackboneElement Additional order information
ServiceRequest.orderDetail.id 0..1 string Unique id for inter-element referencing
ServiceRequest.orderDetail.parameter This element is included in summaries. 1..* BackboneElement The parameter details for the service being requested
ServiceRequest.orderDetail.parameter.id 0..1 string Unique id for inter-element referencing
ServiceRequest.orderDetail.parameter.code This element is included in summaries. 1..1 CodeableConcept The detail of the order being requested
Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
      "code" : "LOINC",
      "display" : "Test Code"
    }
  ]
}
ServiceRequest.orderDetail.parameter.value[x] This element is included in summaries. 1..1 CodeableConcept The value for the order detail
Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests
ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.subject.id 0..1 id Unique id for inter-element referencing
ServiceRequest.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Constraints: subject-identified
ServiceRequest.subject.display This element is included in summaries. C 0..1 string Text alternative for the resource
ServiceRequest.focus This element is included in summaries. 0..* Reference(Resource) What the service request is about, when it is not about the subject of record
ServiceRequest.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ServiceRequest.requester.id 0..1 id Unique id for inter-element referencing
ServiceRequest.requester.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.requester.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.requester.type This element is included in summaries. 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Practitioner (no extensions allowed)
ServiceRequest.specimen This element is included in summaries. 1..1 Reference(Specimen) Procedure Samples
ServiceRequest.specimen.id 0..1 id Unique id for inter-element referencing
ServiceRequest.specimen.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.specimen.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.specimen.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
ServiceRequest.specimen.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.specimen.display This element is included in summaries. C 0..1 string Text alternative for the resource
ServiceRequest.bodyStructure This element is included in summaries. C 0..1 Reference(BodyStructure) BodyStructure-based location on the body
ServiceRequest.note 0..* Annotation Comments
ServiceRequest.note.id 0..1 id Unique id for inter-element referencing
ServiceRequest.note.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.note.text This element is included in summaries. 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base required All Languages 📍5.0.0 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍5.0.0 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍5.0.0 FHIR Std.
ServiceRequest.category Base required Service Request Category Codes 📦5.0.0 FHIR Std.
ServiceRequest.priority Base required RequestPriority 📍5.0.0 FHIR Std.
ServiceRequest.code Base preferred http://loinc.org Not State Unknown
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.value[x] Base preferred http://loinc.org Not State Unknown
ServiceRequest.requester.​type Base extensible Resource Types 📍5.0.0 FHIR Std.
ServiceRequest.specimen.​type Base extensible Resource Types 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdystr-1 error ServiceRequest bodyStructure SHALL only be present if bodySite is not present bodySite.exists() implies bodyStructure.empty()
dom-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()
subject-identified error ServiceRequest.subject.reference If there is no identifier then it must have a key hasValue() or subject.identifier.count()

This structure is derived from ServiceRequest

Summary

Mandatory: 6 elements(4 nested mandatory elements)
Fixed: 7 elements
Prohibited: 42 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron