Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena ServiceRequest

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-servicerequest-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaServiceRequest

athena servicerequest profile

This ServiceRequest profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

This resource is a record of a request for service such as diagnostic investigations, treatments, or operations to be performed

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access ServiceRequest resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The ServiceRequest resource is a record of a request for service such as diagnostic investigations, treatments, or operations to be performed. It is derived from the ORDERS table in athenaPractice and in athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

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..* ServiceRequest A request for a service to be performed
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena ServiceRequest Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-servicerequest-profile
.... Slices for security 0..4 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
..... security:LOCATION 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
..... security:CONFTYPEID 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
.... tag 1..2 Coding Tags applied to this resource
... identifier 0..* Identifier Identifiers assigned to this order
... intent 1..1 code plan | order
... category 0..1 CodeableConcept service | referral | test
... priority 0..1 code routine | urgent | asap | stat
... code 1..1 CodeableConcept What is being requested/ordered
... subject 1..1 Reference(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 dateTime When service should occur
... requester 0..1 Reference(Practitioner) Who/what is requesting service
... performer 0..1 Reference(Practitioner) Requested performer
... reasonCode 0..1 CodeableConcept Explanation/Justification for procedure or service
... supportingInfo 0..1 Reference(Condition) Additional clinical information
... note 0..* Annotation Comments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena ServiceRequest Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-servicerequest-profile
.... Slices for security Σ 0..4 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
..... security:LOCATION Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
..... security:CONFTYPEID Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
.... tag Σ 1..2 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".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..* Identifier Identifiers assigned to this order
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ 1..1 code plan | order
Binding: RequestIntent (required): The kind of service request.

... category Σ 0..1 CodeableConcept service | referral | test
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)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

... subject Σ 1..1 Reference(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 dateTime When service should occur
... requester Σ 0..1 Reference(Practitioner) Who/what is requesting service
... performer Σ 0..1 Reference(Practitioner) Requested performer
... reasonCode Σ 0..1 CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.


... supportingInfo 0..1 Reference(Condition) Additional clinical information
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:LOCATIONextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:CONFTYPEIDextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena ServiceRequest Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-servicerequest-profile
.... Slices for security Σ 0..4 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... security:LOCATION Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... security:CONFTYPEID Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 1..2 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".


... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition Σ 0..1 Identifier Composite Request ID
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ 1..1 code plan | order
Binding: RequestIntent (required): The kind of service request.

... category Σ 0..1 CodeableConcept service | referral | test
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)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

... 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(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 dateTime When service should occur
... 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 Σ 0..1 Reference(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..1 Reference(Practitioner) 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..1 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..1 Reference(Condition) 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:LOCATIONextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:CONFTYPEIDextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

This structure is derived from ServiceRequest

Summary

Mandatory: 5 elements(9 nested mandatory elements)
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.meta.profile
  • The element 1 is sliced based on the value of ServiceRequest.meta.security

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena ServiceRequest Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-servicerequest-profile
.... Slices for security 0..4 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
..... security:LOCATION 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
..... security:CONFTYPEID 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
.... tag 1..2 Coding Tags applied to this resource
... identifier 0..* Identifier Identifiers assigned to this order
... intent 1..1 code plan | order
... category 0..1 CodeableConcept service | referral | test
... priority 0..1 code routine | urgent | asap | stat
... code 1..1 CodeableConcept What is being requested/ordered
... subject 1..1 Reference(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 dateTime When service should occur
... requester 0..1 Reference(Practitioner) Who/what is requesting service
... performer 0..1 Reference(Practitioner) Requested performer
... reasonCode 0..1 CodeableConcept Explanation/Justification for procedure or service
... supportingInfo 0..1 Reference(Condition) Additional clinical information
... note 0..* Annotation Comments

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena ServiceRequest Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-servicerequest-profile
.... Slices for security Σ 0..4 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
..... security:LOCATION Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
..... security:CONFTYPEID Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
.... tag Σ 1..2 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".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..* Identifier Identifiers assigned to this order
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ 1..1 code plan | order
Binding: RequestIntent (required): The kind of service request.

... category Σ 0..1 CodeableConcept service | referral | test
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)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

... subject Σ 1..1 Reference(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 dateTime When service should occur
... requester Σ 0..1 Reference(Practitioner) Who/what is requesting service
... performer Σ 0..1 Reference(Practitioner) Requested performer
... reasonCode Σ 0..1 CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.


... supportingInfo 0..1 Reference(Condition) Additional clinical information
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:LOCATIONextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:CONFTYPEIDextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena ServiceRequest Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-servicerequest-profile
.... Slices for security Σ 0..4 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... security:LOCATION Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... security:CONFTYPEID Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 1..2 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".


... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition Σ 0..1 Identifier Composite Request ID
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ 1..1 code plan | order
Binding: RequestIntent (required): The kind of service request.

... category Σ 0..1 CodeableConcept service | referral | test
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)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

... 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(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 dateTime When service should occur
... 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 Σ 0..1 Reference(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..1 Reference(Practitioner) 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..1 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..1 Reference(Condition) 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:LOCATIONextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.security:CONFTYPEIDextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ServiceRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

This structure is derived from ServiceRequest

Summary

Mandatory: 5 elements(9 nested mandatory elements)
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.meta.profile
  • The element 1 is sliced based on the value of ServiceRequest.meta.security

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for ServiceRequest resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/ServiceRequest?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results ServiceRequest resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
_security (token) Search by a security label
_tag (token) Search by a resource tag
_lastUpdated (date)
_lastUpdated-fromnow (quantity) Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
identifier (token) Identifiers assigned to this order
category (token) Classification of service
code (token) What is being requested/ordered
encounter (reference) An encounter in which this request is made
encounter-or-historical (reference)
intent (token) plan | order
occurrence (date) When service should occur
occurrence-fromnow (quantity) Like occurrence except expressed as a positive or negative offset from the current time in units of time, e.g. occurrence-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
performer (reference) Requested performer
priority (token) routine | urgent | stat
requester (reference) Who/what is requesting service
status (token) draft | active | on-hold | revoked | completed | entered-in-error
subject (reference) Search by subject
patient (reference) Search by subject - a patient
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.