HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

This page is part of the HL7 Europe Imaging Study Report (v0.1.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: IM Imaging Order

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImOrder Version: 0.1.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: ImOrder

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

This profile on ServiceRequest represents the order for the Imaging Study and report.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
bdystr-1: bodyStructure SHALL only be present if bodySite is not present
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
... contained 0..* Resource Contained, inline Resources
... 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
.... identifier:accessionNumber Σ 0..1 ImAccessionNumberIdentifier Identifiers assigned to this order
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 +
Binding: RequestIntent (required): The kind of service request.


ele-1: All FHIR elements must have a @value or children
... Slices for category Σ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ele-1: All FHIR elements must have a @value or children
.... category:imaging Σ 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 363679005
...... display 1..1 string Representation defined by the system
Fixed Value: Imaging
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
ele-1: All FHIR elements must have a @value or children
... code ΣC 0..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (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
... subject Σ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ele-1: All FHIR elements must have a @value or children
... Slices for supportingInfo 0..* CodeableReference(Resource) Additional clinical information
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:pregnancy 0..1 CodeableReference(Resource) Additional clinical information
Binding: Pregnancy Status - IPS (required)
ele-1: All FHIR elements must have a @value or children
... note 0..* Annotation Comments
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:imagingexamplePattern: SNOMED-CT Code 363679005("Imaging")
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodesSNOMEDCT
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.supportingInfo:pregnancyrequiredPregnancyStatusUvIps
http://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
bdystr-1errorServiceRequestbodyStructure SHALL only be present if bodySite is not present
: bodySite.exists() implies bodyStructure.empty()
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
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()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest ServiceRequest
... Slices for identifier 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:accessionNumber 0..1 ImAccessionNumberIdentifier Identifiers assigned to this order
... Slices for category 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
.... category:imaging 1..1 CodeableConcept Classification of service
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 363679005
...... display 1..1 string Representation defined by the system
Fixed Value: Imaging
... code 0..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
... reason
.... concept 0..1 CodeableConcept Reference to a concept (by class)
..... text 0..1 string Plain text representation of the concept
... Slices for supportingInfo 0..* CodeableReference(Resource) Additional clinical information
Slice: Unordered, Open by value:$this
.... supportingInfo:pregnancy 0..1 CodeableReference(Resource) Additional clinical information
Binding: Pregnancy Status - IPS (required)
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.supportingInfo:pregnancyrequiredPregnancyStatusUvIps
http://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
bdystr-1: bodyStructure SHALL only be present if bodySite is not present
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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter
... 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
... Slices for identifier Σ 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:accessionNumber Σ 0..1 ImAccessionNumberIdentifier 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 | unknown
Binding: RequestStatus (required): The status of a service order.

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

... Slices for category Σ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:imaging Σ 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 363679005
...... display 1..1 string Representation defined by the system
Fixed Value: Imaging
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... 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 ΣC 0..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (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.

... orderDetail ΣC 0..* BackboneElement Additional order information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... parameterFocus 0..1 CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) The context of the order details by reference
.... parameter Σ 1..* BackboneElement The parameter details for the service being requested
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept The detail of the order being requested
Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters.

..... value[x] Σ 1..1 The value for the order detail
...... valueQuantity Quantity
...... valueRatio Ratio
...... valueRange Range
...... valueBoolean boolean
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valuePeriod Period
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject Σ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
... focus Σ 0..* Reference(Resource) What the service request is about, when it is not about the subject of record
... 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 Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) 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(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... location Σ 0..* CodeableReference(Location) Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... reason Σ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes


.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... Slices for supportingInfo 0..* CodeableReference(Resource) Additional clinical information
Slice: Unordered, Open by value:$this
.... supportingInfo:pregnancy 0..1 CodeableReference(Resource) Additional clinical information
Binding: Pregnancy Status - IPS (required)
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite ΣC 0..* CodeableConcept Coded location on Body
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts


... bodyStructure ΣC 0..1 Reference(BodyStructure) BodyStructure-based location on the body
... note 0..* Annotation Comments
... patientInstruction 0..* BackboneElement Patient or consumer-oriented instructions
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... instruction[x] Σ 0..1 Patient or consumer-oriented instructions
..... instructionMarkdown markdown
..... instructionReference Reference(DocumentReference)
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:imagingexamplePattern: SNOMED-CT Code 363679005("Imaging")
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodesSNOMEDCT
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.orderDetail.parameter.codeexampleServiceRequestOrderDetailParameterCode
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail-parameter-code
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.locationexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
ServiceRequest.supportingInfo:pregnancyrequiredPregnancyStatusUvIps
http://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdystr-1errorServiceRequestbodyStructure SHALL only be present if bodySite is not present
: bodySite.exists() implies bodyStructure.empty()
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
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()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.identifier
  • The element 1 is sliced based on the value of ServiceRequest.category
  • The element 1 is sliced based on the value of ServiceRequest.supportingInfo

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
bdystr-1: bodyStructure SHALL only be present if bodySite is not present
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
... contained 0..* Resource Contained, inline Resources
... 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
.... identifier:accessionNumber Σ 0..1 ImAccessionNumberIdentifier Identifiers assigned to this order
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 +
Binding: RequestIntent (required): The kind of service request.


ele-1: All FHIR elements must have a @value or children
... Slices for category Σ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ele-1: All FHIR elements must have a @value or children
.... category:imaging Σ 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 363679005
...... display 1..1 string Representation defined by the system
Fixed Value: Imaging
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
ele-1: All FHIR elements must have a @value or children
... code ΣC 0..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (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
... subject Σ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ele-1: All FHIR elements must have a @value or children
... Slices for supportingInfo 0..* CodeableReference(Resource) Additional clinical information
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... supportingInfo:pregnancy 0..1 CodeableReference(Resource) Additional clinical information
Binding: Pregnancy Status - IPS (required)
ele-1: All FHIR elements must have a @value or children
... note 0..* Annotation Comments
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:imagingexamplePattern: SNOMED-CT Code 363679005("Imaging")
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodesSNOMEDCT
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.supportingInfo:pregnancyrequiredPregnancyStatusUvIps
http://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
bdystr-1errorServiceRequestbodyStructure SHALL only be present if bodySite is not present
: bodySite.exists() implies bodyStructure.empty()
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
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()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest ServiceRequest
... Slices for identifier 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:accessionNumber 0..1 ImAccessionNumberIdentifier Identifiers assigned to this order
... Slices for category 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
.... category:imaging 1..1 CodeableConcept Classification of service
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 363679005
...... display 1..1 string Representation defined by the system
Fixed Value: Imaging
... code 0..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
... reason
.... concept 0..1 CodeableConcept Reference to a concept (by class)
..... text 0..1 string Plain text representation of the concept
... Slices for supportingInfo 0..* CodeableReference(Resource) Additional clinical information
Slice: Unordered, Open by value:$this
.... supportingInfo:pregnancy 0..1 CodeableReference(Resource) Additional clinical information
Binding: Pregnancy Status - IPS (required)
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.supportingInfo:pregnancyrequiredPregnancyStatusUvIps
http://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
bdystr-1: bodyStructure SHALL only be present if bodySite is not present
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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter
... 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
... Slices for identifier Σ 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:accessionNumber Σ 0..1 ImAccessionNumberIdentifier 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 | unknown
Binding: RequestStatus (required): The status of a service order.

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

... Slices for category Σ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:imaging Σ 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 363679005
...... display 1..1 string Representation defined by the system
Fixed Value: Imaging
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... 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 ΣC 0..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (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.

... orderDetail ΣC 0..* BackboneElement Additional order information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... parameterFocus 0..1 CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) The context of the order details by reference
.... parameter Σ 1..* BackboneElement The parameter details for the service being requested
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept The detail of the order being requested
Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters.

..... value[x] Σ 1..1 The value for the order detail
...... valueQuantity Quantity
...... valueRatio Ratio
...... valueRange Range
...... valueBoolean boolean
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valuePeriod Period
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject Σ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
... focus Σ 0..* Reference(Resource) What the service request is about, when it is not about the subject of record
... 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 Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) 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(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... location Σ 0..* CodeableReference(Location) Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... reason Σ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes


.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... Slices for supportingInfo 0..* CodeableReference(Resource) Additional clinical information
Slice: Unordered, Open by value:$this
.... supportingInfo:pregnancy 0..1 CodeableReference(Resource) Additional clinical information
Binding: Pregnancy Status - IPS (required)
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite ΣC 0..* CodeableConcept Coded location on Body
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts


... bodyStructure ΣC 0..1 Reference(BodyStructure) BodyStructure-based location on the body
... note 0..* Annotation Comments
... patientInstruction 0..* BackboneElement Patient or consumer-oriented instructions
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... instruction[x] Σ 0..1 Patient or consumer-oriented instructions
..... instructionMarkdown markdown
..... instructionReference Reference(DocumentReference)
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:imagingexamplePattern: SNOMED-CT Code 363679005("Imaging")
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodesSNOMEDCT
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.orderDetail.parameter.codeexampleServiceRequestOrderDetailParameterCode
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail-parameter-code
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.locationexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
ServiceRequest.supportingInfo:pregnancyrequiredPregnancyStatusUvIps
http://hl7.org/fhir/uv/ips/ValueSet/pregnancy-status-uv-ips
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdystr-1errorServiceRequestbodyStructure SHALL only be present if bodySite is not present
: bodySite.exists() implies bodyStructure.empty()
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
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()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.identifier
  • The element 1 is sliced based on the value of ServiceRequest.category
  • The element 1 is sliced based on the value of ServiceRequest.supportingInfo

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron