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
| 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:
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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: bdystr-1, prr-1 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |
![]() ![]() |
0..1 | Identifier | Order grouping identifier, shared by the ServiceRequests of one multi-tube order | |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |
![]() ![]() ![]() |
C | 1..1 | string | Requisition value — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error Binding: RequestStatus (required): The status of a service order. | |
![]() ![]() |
1..1 | code | order | reflex-order Binding: RequestIntent (required): The kind of service request. Fixed Value: order (no extensions allowed) | |
![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |
![]() ![]() |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
C | 0..* | BackboneElement | Additional order information |
![]() ![]() ![]() |
1..* | BackboneElement | The parameter details for the service being requested | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value for the order detail Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests | |
![]() ![]() |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified |
![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
ServiceRequest | |||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..0 | Not used — see identifiers.html#sample-identifiers | ||
![]() ![]() |
0..0 | Instantiates FHIR protocol or definition | ||
![]() ![]() |
0..0 | Instantiates external protocol or definition | ||
![]() ![]() |
0..0 | What request fulfills | ||
![]() ![]() |
0..0 | What request replaces | ||
![]() ![]() |
0..1 | Identifier | Order grouping identifier, shared by the ServiceRequests of one multi-tube order | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | Requisition value — alphanumeric and hyphens only | |
![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error | |
![]() ![]() |
1..1 | code | order | reflex-order Fixed Value: order (no extensions allowed) | |
![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | Version of the system - if relevant | ||
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Fixed Value: Laboratory procedure (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | If this coding was chosen directly by the user | ||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |
![]() ![]() |
0..0 | True if service/procedure should not be performed | ||
![]() ![]() |
1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..* | BackboneElement | Additional order information | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | The context of the order details by reference | ||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The detail of the order being requested Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value for the order detail Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests | |
![]() ![]() |
0..0 | Service amount | ||
![]() ![]() |
||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified |
![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") - must be a resource in resources | ||
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() |
0..0 | Encounter in which the request was created | ||
![]() ![]() |
0..0 | When service should occur | ||
![]() ![]() |
0..0 | Preconditions for service | ||
![]() ![]() |
0..0 | Date request signed | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() ![]() |
1..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Fixed Value: Practitioner (no extensions allowed) | |
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() |
0..0 | Performer role | ||
![]() ![]() |
0..0 | Requested performer | ||
![]() ![]() |
0..0 | Requested location | ||
![]() ![]() |
0..0 | Explanation/Justification for procedure or service | ||
![]() ![]() |
0..0 | Associated insurance coverage | ||
![]() ![]() |
0..0 | Additional clinical information | ||
![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() |
0..0 | Coded location on Body | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Individual responsible for the annotation | ||
![]() ![]() ![]() |
0..0 | When the annotation was made | ||
![]() ![]() |
0..0 | Patient or consumer-oriented instructions | ||
![]() ![]() |
0..0 | Request provenance | ||
Documentation for this format | ||||
| 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 |
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: bdystr-1, prr-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |||||
![]() ![]() |
0..1 | Identifier | Order grouping identifier, shared by the ServiceRequests of one multi-tube order | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |||||
![]() ![]() ![]() |
C | 1..1 | string | Requisition value — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error Binding: RequestStatus (required): The status of a service order. | |||||
![]() ![]() |
1..1 | code | order | reflex-order Binding: RequestIntent (required): The kind of service request. Fixed Value: order (no extensions allowed) | |||||
![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 (no extensions allowed) | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system Fixed Value: Laboratory procedure (no extensions allowed) | ||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |||||
![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference to a concept (by class) | |||||
![]() ![]() ![]() |
0..1 | Reference() | Reference to a resource (by instance) | |||||
![]() ![]() |
C | 0..* | BackboneElement | Additional order information | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
1..* | BackboneElement | The parameter details for the service being requested | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. Required Pattern: | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value for the order detail Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests | |||||
![]() ![]() |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified | ||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record | |||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
C | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
C | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | ||||
![]() ![]() |
0..* | Annotation | Comments | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
1..1 | markdown | The annotation - text content (as markdown) | |||||
Documentation for this format | ||||||||
| 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. |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: bdystr-1, prr-1 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |
![]() ![]() |
0..1 | Identifier | Order grouping identifier, shared by the ServiceRequests of one multi-tube order | |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |
![]() ![]() ![]() |
C | 1..1 | string | Requisition value — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error Binding: RequestStatus (required): The status of a service order. | |
![]() ![]() |
1..1 | code | order | reflex-order Binding: RequestIntent (required): The kind of service request. Fixed Value: order (no extensions allowed) | |
![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |
![]() ![]() |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
C | 0..* | BackboneElement | Additional order information |
![]() ![]() ![]() |
1..* | BackboneElement | The parameter details for the service being requested | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value for the order detail Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests | |
![]() ![]() |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified |
![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
ServiceRequest | |||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..0 | Not used — see identifiers.html#sample-identifiers | ||
![]() ![]() |
0..0 | Instantiates FHIR protocol or definition | ||
![]() ![]() |
0..0 | Instantiates external protocol or definition | ||
![]() ![]() |
0..0 | What request fulfills | ||
![]() ![]() |
0..0 | What request replaces | ||
![]() ![]() |
0..1 | Identifier | Order grouping identifier, shared by the ServiceRequests of one multi-tube order | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | Requisition value — alphanumeric and hyphens only | |
![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error | |
![]() ![]() |
1..1 | code | order | reflex-order Fixed Value: order (no extensions allowed) | |
![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | Version of the system - if relevant | ||
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Fixed Value: Laboratory procedure (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | If this coding was chosen directly by the user | ||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |
![]() ![]() |
0..0 | True if service/procedure should not be performed | ||
![]() ![]() |
1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..* | BackboneElement | Additional order information | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | The context of the order details by reference | ||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The detail of the order being requested Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value for the order detail Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests | |
![]() ![]() |
0..0 | Service amount | ||
![]() ![]() |
||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified |
![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") - must be a resource in resources | ||
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() |
0..0 | Encounter in which the request was created | ||
![]() ![]() |
0..0 | When service should occur | ||
![]() ![]() |
0..0 | Preconditions for service | ||
![]() ![]() |
0..0 | Date request signed | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() ![]() |
1..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Fixed Value: Practitioner (no extensions allowed) | |
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() |
0..0 | Performer role | ||
![]() ![]() |
0..0 | Requested performer | ||
![]() ![]() |
0..0 | Requested location | ||
![]() ![]() |
0..0 | Explanation/Justification for procedure or service | ||
![]() ![]() |
0..0 | Associated insurance coverage | ||
![]() ![]() |
0..0 | Additional clinical information | ||
![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() |
0..0 | Coded location on Body | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Individual responsible for the annotation | ||
![]() ![]() ![]() |
0..0 | When the annotation was made | ||
![]() ![]() |
0..0 | Patient or consumer-oriented instructions | ||
![]() ![]() |
0..0 | Request provenance | ||
Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: bdystr-1, prr-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | Reference(SenaiteOrganization) | The submitting client organisation URL: https://fhir.senaite.org/StructureDefinition/SenaiteClient | |||||
![]() ![]() |
0..1 | Identifier | Order grouping identifier, shared by the ServiceRequests of one multi-tube order | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |||||
![]() ![]() ![]() |
C | 1..1 | string | Requisition value — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | entered-in-error Binding: RequestStatus (required): The status of a service order. | |||||
![]() ![]() |
1..1 | code | order | reflex-order Binding: RequestIntent (required): The kind of service request. Fixed Value: order (no extensions allowed) | |||||
![]() ![]() |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (required): Classification of the requested service. | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 (no extensions allowed) | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system Fixed Value: Laboratory procedure (no extensions allowed) | ||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Fixed Value: Laboratory procedure (no extensions allowed) | |||||
![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: http://loinc.org (preferred): For laboratory codes | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference to a concept (by class) | |||||
![]() ![]() ![]() |
0..1 | Reference() | Reference to a resource (by instance) | |||||
![]() ![]() |
C | 0..* | BackboneElement | Additional order information | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
1..* | BackboneElement | The parameter details for the service being requested | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. Required Pattern: | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value for the order detail Binding: http://loinc.org (preferred): LOINC codes for individual laboratory tests | |||||
![]() ![]() |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL Constraints: subject-identified | ||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record | |||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() |
1..1 | Reference(Specimen) | Procedure Samples | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
C | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
C | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | ||||
![]() ![]() |
0..* | Annotation | Comments | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
1..1 | markdown | The annotation - text content (as markdown) | |||||
Documentation for this format | ||||||||
| 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. |
| 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
Other representations of profile: CSV, Excel, Schematron