OpenMRS FHIR2 Implementation Guide
0.1.0 - ci-build

OpenMRS FHIR2 Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: OpenMRS Service Request

Defining URL:http://fhir.openmrs.org/fhir/StructureDefinition/OpenMRS-service-request
Version:0.1.0
Name:OpenMRSServiceRequest
Title:OpenMRS Service Request
Status:Active as of 2022-11-29 05:06:49+0000
Definition:

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

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://fhir.openmrs.org/fhir/StructureDefinition/OpenMRS-service-request

Formal Views of Profile Content

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

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... id 0..1idLogical id of this artifact
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..*Reference(OpenMRS Service Request)What request fulfills
... replaces 0..*Reference(OpenMRS Service Request)What request replaces
... requisition 0..0
... status 1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... category 0..0
... priority 0..0
... doNotPerform 0..0
... code 1..1CodeableConceptWhat is being requested/ordered
.... coding 1..*CodingCode defined by a terminology system
Binding: OpenMRS Order Code (required)
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1Reference(OpenMRS Patient)Individual or Entity the service is ordered for
... occurrence[x] 0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] 0..0
... authoredOn 0..0
... requester 1..1Reference(Openmrs Practitioner)Who/what is requesting service
... performerType 0..0
... performer 0..*Reference(OpenMRS Patient)Requested performer
... locationCode 0..0
... locationReference 0..0
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... note 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... basedOn Σ0..*Reference(OpenMRS Service Request)What request fulfills
... replaces Σ0..*Reference(OpenMRS Service Request)What request replaces
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... code Σ1..1CodeableConceptWhat 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..*CodingCode defined by a terminology system
Binding: OpenMRS Order Code (required)
.... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(OpenMRS Patient)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... requester Σ1..1Reference(Openmrs Practitioner)Who/what is requesting service
... performer Σ0..*Reference(OpenMRS Patient)Requested performer

doco Documentation for this format

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... id 0..1idLogical id of this artifact
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..*Reference(OpenMRS Service Request)What request fulfills
... replaces 0..*Reference(OpenMRS Service Request)What request replaces
... requisition 0..0
... status 1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... category 0..0
... priority 0..0
... doNotPerform 0..0
... code 1..1CodeableConceptWhat is being requested/ordered
.... coding 1..*CodingCode defined by a terminology system
Binding: OpenMRS Order Code (required)
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1Reference(OpenMRS Patient)Individual or Entity the service is ordered for
... occurrence[x] 0..1dateTime, Period, TimingWhen service should occur
... asNeeded[x] 0..0
... authoredOn 0..0
... requester 1..1Reference(Openmrs Practitioner)Who/what is requesting service
... performerType 0..0
... performer 0..*Reference(OpenMRS Patient)Requested performer
... locationCode 0..0
... locationReference 0..0
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... note 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... basedOn Σ0..*Reference(OpenMRS Service Request)What request fulfills
... replaces Σ0..*Reference(OpenMRS Service Request)What request replaces
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... code Σ1..1CodeableConceptWhat 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..*CodingCode defined by a terminology system
Binding: OpenMRS Order Code (required)
.... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(OpenMRS Patient)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... requester Σ1..1Reference(Openmrs Practitioner)Who/what is requesting service
... performer Σ0..*Reference(OpenMRS Patient)Requested performer

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredRequestIntent
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
ServiceRequest.code.codingrequiredOpenMRSOrderCodeVS (a valid code from LOINC)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()