OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build
OpenMRS Core FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://fhir.openmrs.org/core/StructureDefinition/OpenMRS-service-request | Version: 0.1.0 | |||
Active as of 2024-12-11 | Computable Name: OpenMRSServiceRequest |
Service Request Resource is represents a request for some type of procedure or diagnostic test to be performed. When fulfilled, the results of this request are represented as a DiagnosticReport resource with associated Observation resources
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
id | 1..1 | id | Logical id of this artifact | |
basedOn | 0..* | Reference(OpenMRS Service Request) | What request fulfills | |
replaces | 0..* | Reference(OpenMRS Service Request) | What request replaces | |
status | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
code | 1..1 | CodeableConcept | What is being requested/ordered | |
coding | 1..* | Coding | Code defined by a terminology system Binding: OpenMRS Order Code (required) | |
subject | 1..1 | Reference(OpenMRS Patient) | Individual or Entity the service is ordered for | |
occurrence[x] | 0..1 | dateTime, Period, Timing | When service should occur | |
requester | 1..1 | Reference(Openmrs Practitioner) | Who/what is requesting service | |
performer | 0..* | Reference(OpenMRS Patient) | Requested performer | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.code.coding | required | OpenMRSOrderCodeVS (a valid code from LOINC)http://fhir.openmrs.org/core/ValueSet/OpenMRS-order-code-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present |
id | Σ | 1..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
basedOn | Σ | 0..* | Reference(OpenMRS Service Request) | What request fulfills ele-1: All FHIR elements must have a @value or children |
replaces | Σ | 0..* | Reference(OpenMRS Service Request) | What request replaces ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children |
code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. ele-1: All FHIR elements must have a @value or children |
coding | Σ | 1..* | Coding | Code defined by a terminology system Binding: OpenMRS Order Code (required) ele-1: All FHIR elements must have a @value or children |
subject | Σ | 1..1 | Reference(OpenMRS Patient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children |
occurrence[x] | Σ | 0..1 | When service should occur ele-1: All FHIR elements must have a @value or children | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
requester | Σ | 1..1 | Reference(Openmrs Practitioner) | Who/what is requesting service ele-1: All FHIR elements must have a @value or children |
performer | Σ | 0..* | Reference(OpenMRS Patient) | Requested performer ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | |
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | |
ServiceRequest.code.coding | required | OpenMRSOrderCodeVS (a valid code from LOINC)http://fhir.openmrs.org/core/ValueSet/OpenMRS-order-code-vs from this IG |
Id | Grade | Path(s) | Details | Requirements |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
id | Σ | 1..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(OpenMRS Service Request) | What request fulfills | ||||
replaces | Σ | 0..* | Reference(OpenMRS Service Request) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..* | Coding | Code defined by a terminology system Binding: OpenMRS Order Code (required) | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | Σ | 1..1 | Reference(OpenMRS Patient) | Individual or Entity the service is ordered for | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
occurrence[x] | Σ | 0..1 | When service should occur | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | Σ | 0..1 | dateTime | Date request signed | ||||
requester | Σ | 1..1 | Reference(Openmrs Practitioner) | Who/what is requesting service | ||||
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
performer | Σ | 0..* | Reference(OpenMRS Patient) | Requested performer | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
ServiceRequest.code.coding | required | OpenMRSOrderCodeVS (a valid code from LOINC)http://fhir.openmrs.org/core/ValueSet/OpenMRS-order-code-vs from this IG | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role from the FHIR Standard | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-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() |
This structure is derived from ServiceRequest
Differential View
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
id | 1..1 | id | Logical id of this artifact | |
basedOn | 0..* | Reference(OpenMRS Service Request) | What request fulfills | |
replaces | 0..* | Reference(OpenMRS Service Request) | What request replaces | |
status | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
code | 1..1 | CodeableConcept | What is being requested/ordered | |
coding | 1..* | Coding | Code defined by a terminology system Binding: OpenMRS Order Code (required) | |
subject | 1..1 | Reference(OpenMRS Patient) | Individual or Entity the service is ordered for | |
occurrence[x] | 0..1 | dateTime, Period, Timing | When service should occur | |
requester | 1..1 | Reference(Openmrs Practitioner) | Who/what is requesting service | |
performer | 0..* | Reference(OpenMRS Patient) | Requested performer | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.code.coding | required | OpenMRSOrderCodeVS (a valid code from LOINC)http://fhir.openmrs.org/core/ValueSet/OpenMRS-order-code-vs from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present |
id | Σ | 1..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
basedOn | Σ | 0..* | Reference(OpenMRS Service Request) | What request fulfills ele-1: All FHIR elements must have a @value or children |
replaces | Σ | 0..* | Reference(OpenMRS Service Request) | What request replaces ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children |
code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. ele-1: All FHIR elements must have a @value or children |
coding | Σ | 1..* | Coding | Code defined by a terminology system Binding: OpenMRS Order Code (required) ele-1: All FHIR elements must have a @value or children |
subject | Σ | 1..1 | Reference(OpenMRS Patient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children |
occurrence[x] | Σ | 0..1 | When service should occur ele-1: All FHIR elements must have a @value or children | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
requester | Σ | 1..1 | Reference(Openmrs Practitioner) | Who/what is requesting service ele-1: All FHIR elements must have a @value or children |
performer | Σ | 0..* | Reference(OpenMRS Patient) | Requested performer ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | |
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | |
ServiceRequest.code.coding | required | OpenMRSOrderCodeVS (a valid code from LOINC)http://fhir.openmrs.org/core/ValueSet/OpenMRS-order-code-vs from this IG |
Id | Grade | Path(s) | Details | Requirements |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
id | Σ | 1..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(OpenMRS Service Request) | What request fulfills | ||||
replaces | Σ | 0..* | Reference(OpenMRS Service Request) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..* | Coding | Code defined by a terminology system Binding: OpenMRS Order Code (required) | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | Σ | 1..1 | Reference(OpenMRS Patient) | Individual or Entity the service is ordered for | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
occurrence[x] | Σ | 0..1 | When service should occur | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | Σ | 0..1 | dateTime | Date request signed | ||||
requester | Σ | 1..1 | Reference(Openmrs Practitioner) | Who/what is requesting service | ||||
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
performer | Σ | 0..* | Reference(OpenMRS Patient) | Requested performer | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
ServiceRequest.code.coding | required | OpenMRSOrderCodeVS (a valid code from LOINC)http://fhir.openmrs.org/core/ValueSet/OpenMRS-order-code-vs from this IG | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role from the FHIR Standard | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-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() |
This structure is derived from ServiceRequest
Other representations of profile: CSV, Excel, Schematron