Athena Core Implementation Guide
4.2.0 - release

Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: athenahealth ServiceRequest

Official URL: https://fhir.athena.io/StructureDefinition/ah-servicerequest Version: 4.2.0
Active as of 2025-04-17 Computable Name: AthenahealthServiceRequest
Keywords: Wire Format

BETA: A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

ServiceRequest is a record of a request for a procedure or diagnostic or other service to be planned, proposed, or performed, as distinguished by the ServiceRequest.intent field value, with or on a patient. The service to be performed would result in a Procedure, Observation, DiagnosticReport, ImagingStudy or similar resource.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

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
... meta
.... lastUpdated 0..1 instant When the resource version last changed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... instantiatesCanonical 0..0
... basedOn 0..0
... replaces 0..0
... requisition 0..0
... category
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... priority 0..0
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1 Reference(Patient) Individual or Entity the service is ordered for
... occurrence[x] 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... asNeeded[x] 0..0
... requester 0..1 Reference(Practitioner) Who/what is requesting service
... performerType 0..0
... performer 0..* Reference(Practitioner | Organization) Requested performer
... locationCode 0..0
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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
... 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
... subject Σ 1..1 Reference(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
... requester Σ 0..1 Reference(Practitioner) Who/what is requesting service
ele-1: All FHIR elements must have a @value or children
... performer Σ 0..* Reference(Practitioner | Organization) Requested performer
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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
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 Σ 0..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
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 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".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifiers assigned to this order
... 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.


.... 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..1 Coding Code defined by a terminology 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 Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code Σ 0..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.

... 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 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime Date request signed
... requester Σ 0..1 Reference(Practitioner) Who/what is requesting service
... performer Σ 0..* Reference(Practitioner | Organization) Requested performer
... 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.


... 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.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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.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

This structure is derived from ServiceRequest

Summary

Mandatory: 2 elements(4 nested mandatory elements)
Prohibited: 18 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... meta
.... lastUpdated 0..1 instant When the resource version last changed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... instantiatesCanonical 0..0
... basedOn 0..0
... replaces 0..0
... requisition 0..0
... category
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... priority 0..0
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1 Reference(Patient) Individual or Entity the service is ordered for
... occurrence[x] 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... asNeeded[x] 0..0
... requester 0..1 Reference(Practitioner) Who/what is requesting service
... performerType 0..0
... performer 0..* Reference(Practitioner | Organization) Requested performer
... locationCode 0..0
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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
... 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
... subject Σ 1..1 Reference(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
... requester Σ 0..1 Reference(Practitioner) Who/what is requesting service
ele-1: All FHIR elements must have a @value or children
... performer Σ 0..* Reference(Practitioner | Organization) Requested performer
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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

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 Σ 0..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
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 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".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifiers assigned to this order
... 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.


.... 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..1 Coding Code defined by a terminology 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 Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code Σ 0..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.

... 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 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime Date request signed
... requester Σ 0..1 Reference(Practitioner) Who/what is requesting service
... performer Σ 0..* Reference(Practitioner | Organization) Requested performer
... 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.


... 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.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ServiceRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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.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

This structure is derived from ServiceRequest

Summary

Mandatory: 2 elements(4 nested mandatory elements)
Prohibited: 18 elements

Extensions

This structure refers to these extensions:

 

​Other representations of profile: CSV, Excel, Schematron