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 ServiceRequest Revoked

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

The ServiceRequest resource returned by the server in the 200 OK response body after a successful $revoke operation. Identical to SenaiteServiceRequest but with status fixed to revoked, meta.versionId and meta.lastUpdated required to confirm the update was applied, and note optionally populated with the plain-text reason supplied to the $revoke operation.

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..* SenaiteServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1, status-revoked
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.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.
Fixed Value: revoked (no extensions allowed)
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.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

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()
status-revoked error ServiceRequest ServiceRequest.status must be revoked status = 'revoked'
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 SenaiteServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* SenaiteServiceRequest A request for a service to be performed
Constraints: status-revoked
ServiceRequest.meta
ServiceRequest.meta.versionId 1..1 id Version specific identifier
ServiceRequest.meta.lastUpdated 1..1 instant When the resource version last changed
ServiceRequest.status 1..1 code draft | active | on-hold | revoked | entered-in-error
Fixed Value: revoked (no extensions allowed)

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
status-revoked error ServiceRequest ServiceRequest.status must be revoked status = 'revoked'
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* SenaiteServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1, status-revoked
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.meta.id 0..1 id Unique id for inter-element referencing
ServiceRequest.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.meta.versionId This element is included in summaries. 1..1 id Version specific identifier
ServiceRequest.meta.lastUpdated This element is included in summaries. 1..1 instant When the resource version last changed
ServiceRequest.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ServiceRequest.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ServiceRequest.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ServiceRequest.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.
Fixed Value: revoked (no extensions allowed)
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.meta.​security Base extensible All Security Labels 📍5.0.0 FHIR Std.
ServiceRequest.meta.​tag Base example Common Tags 📍5.0.0 FHIR Std.
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()
status-revoked error ServiceRequest ServiceRequest.status must be revoked status = 'revoked'
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 SenaiteServiceRequest

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* SenaiteServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1, status-revoked
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.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.
Fixed Value: revoked (no extensions allowed)
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.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

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()
status-revoked error ServiceRequest ServiceRequest.status must be revoked status = 'revoked'
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 SenaiteServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* SenaiteServiceRequest A request for a service to be performed
Constraints: status-revoked
ServiceRequest.meta
ServiceRequest.meta.versionId 1..1 id Version specific identifier
ServiceRequest.meta.lastUpdated 1..1 instant When the resource version last changed
ServiceRequest.status 1..1 code draft | active | on-hold | revoked | entered-in-error
Fixed Value: revoked (no extensions allowed)

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
status-revoked error ServiceRequest ServiceRequest.status must be revoked status = 'revoked'

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* SenaiteServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1, status-revoked
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.meta.id 0..1 id Unique id for inter-element referencing
ServiceRequest.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.meta.versionId This element is included in summaries. 1..1 id Version specific identifier
ServiceRequest.meta.lastUpdated This element is included in summaries. 1..1 instant When the resource version last changed
ServiceRequest.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ServiceRequest.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ServiceRequest.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ServiceRequest.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.
Fixed Value: revoked (no extensions allowed)
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.meta.​security Base extensible All Security Labels 📍5.0.0 FHIR Std.
ServiceRequest.meta.​tag Base example Common Tags 📍5.0.0 FHIR Std.
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()
status-revoked error ServiceRequest ServiceRequest.status must be revoked status = 'revoked'
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 SenaiteServiceRequest

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element

 

Other representations of profile: CSV, Excel, Schematron