HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
0.0.1 - STU1 International flag

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions

Resource Profile: PT_ServiceRequest

Official URL: http://hl7.pt/fhir/core/StructureDefinition/PTServiceRequest Version: 0.0.1
Active as of 2024-03-08 Computable Name: PT_ServiceRequest

A generic ServiceRequest resource for Portugal

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 ServiceRequest
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patientTransportNeed 0..1codeOptional Extensions Element
URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed
... statusReason 0..*CodeableConceptReason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
Binding: (unbound) (example): Codes identifying the reason for the current state of an event.


... basedOn 0..*Reference(PT_CarePlan)What request fulfills
... requisition 0..1IdentifierComposite Request ID
... status 1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... category 0..1CodeableConceptClassification of service
.... coding 0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required): SNOMED

... priority 0..1coderoutine | urgent | asap | stat
... doNotPerform 0..1booleanTrue if service/procedure should not be performed
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... notPerformReason 0..1CodingExtension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason
.... notPerformDecider 0..1Reference(PT_Practitioner)Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider
... code 0..1CodeableConceptWhat is being requested/ordered
.... coding 0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
... orderDetail 0..*CodeableConceptAdditional order information
... quantity[x] 0..1QuantityService amount
.... value 0..1decimalNumerical value (with implicit precision)
.... unit 0..1stringUnit representation
... subject 1..1Reference(PT_Patient)Individual or Entity the service is ordered for
... encounter 1..1Reference(PT_Encounter)Encounter in which the request was created
... occurrence[x] 0..1TimingWhen service should occur
.... event 0..*dateTimeWhen the event occurs
.... repeat
..... count 0..1positiveIntNumber of times to repeat
... authoredOn 0..1dateTimeDate request signed
... requester 0..1Reference(Device | PT_Practitioner | PT_PractitionerRole)Who/what is requesting service
.... reference 0..1stringLiteral reference, Relative, internal or absolute URL
... performer 0..*Reference(Organization | CareTeam | HealthcareService | PT_Patient | Device | RelatedPerson | PT_Practitioner | PT_PractitionerRole)Requested performer
... locationReference 0..*Reference(PT_Location)Requested location
... reasonCode 0..*CodeableConceptExplanation/Justification for procedure or service
.... coding 0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
... reasonReference 0..*Reference(Observation | DiagnosticReport | DocumentReference | PT_Condition)Explanation/Justification for service or service
... specimen 0..*Reference(PT_Specimen)Procedure Samples
... note
.... author[x] 0..1Reference(Practitioner | Patient | RelatedPerson | Organization)Individual responsible for the annotation
.... text 1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.category.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.code.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.reasonCode.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patientTransportNeed 0..1codeOptional Extensions Element
URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... basedOn Σ0..*Reference(PT_CarePlan)What request fulfills
... requisition Σ0..1IdentifierComposite Request ID
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

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

... category Σ0..1CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required): SNOMED


... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... notPerformReason 0..1CodingExtension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason
.... notPerformDecider 0..1Reference(PT_Practitioner)Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider
... code Σ0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1QuantityService amount
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

.... unit Σ0..1stringUnit representation
... subject Σ1..1Reference(PT_Patient)Individual or Entity the service is ordered for
... encounter Σ1..1Reference(PT_Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1TimingWhen service should occur
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... event Σ0..*dateTimeWhen the event occurs
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Device | PT_Practitioner | PT_PractitionerRole)Who/what is requesting service
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
... performer Σ0..*Reference(Organization | CareTeam | HealthcareService | PT_Patient | Device | RelatedPerson | PT_Practitioner | PT_PractitionerRole)Requested performer
... locationReference Σ0..*Reference(PT_Location)Requested location
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.


.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
... reasonReference Σ0..*Reference(Observation | DiagnosticReport | DocumentReference | PT_Condition)Explanation/Justification for service or service
... specimen Σ0..*Reference(PT_Specimen)Procedure Samples

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
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
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.code.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.quantity[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
ServiceRequest.reasonCode.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patientTransportNeed 0..1codeOptional Extensions Element
URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed
... statusReason 0..*CodeableConceptReason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
Binding: (unbound) (example): Codes identifying the reason for the current state of an event.


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(PT_CarePlan)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

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

... category Σ0..1CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required): SNOMED


.... text Σ0..1stringPlain text representation of the concept
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... notPerformReason 0..1CodingExtension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason
.... notPerformDecider 0..1Reference(PT_Practitioner)Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider
.... value 0..1booleanPrimitive value for boolean
... code Σ0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
.... text Σ0..1stringPlain text representation of the concept
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1QuantityService amount
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

.... unit Σ0..1stringUnit representation
.... system ΣC0..1uriSystem that defines coded unit form
.... code Σ0..1codeCoded form of the unit
... subject Σ1..1Reference(PT_Patient)Individual or Entity the service is ordered for
... encounter Σ1..1Reference(PT_Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1TimingWhen service should occur
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... event Σ0..*dateTimeWhen the event occurs
.... repeat ΣC0..1ElementWhen the event is to occur
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-4: duration SHALL be a non-negative value
tim-5: period SHALL be a non-negative value
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
...... boundsDurationDuration
...... boundsRangeRange
...... boundsPeriodPeriod
..... count Σ0..1positiveIntNumber of times to repeat
..... countMax Σ0..1positiveIntMaximum number of times to repeat
..... duration Σ0..1decimalHow long when it happens
..... durationMax Σ0..1decimalHow long when it happens (Max)
..... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

..... frequency Σ0..1positiveIntEvent occurs frequency times per period
..... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
..... period Σ0..1decimalEvent occurs frequency times per period
..... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
..... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

..... dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
..... timeOfDay Σ0..*timeTime of day for action
..... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


..... offset Σ0..1unsignedIntMinutes from event (before or after)
.... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

... asNeeded[x] Σ0..1Preconditions 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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Device | PT_Practitioner | PT_PractitionerRole)Who/what is requesting service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... performerType Σ0..1CodeableConceptPerformer 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(Organization | CareTeam | HealthcareService | PT_Patient | Device | RelatedPerson | PT_Practitioner | PT_PractitionerRole)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(PT_Location)Requested location
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
.... text Σ0..1stringPlain text representation of the concept
... reasonReference Σ0..*Reference(Observation | DiagnosticReport | DocumentReference | PT_Condition)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(PT_Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... note 0..*AnnotationComments
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Reference(Practitioner | Patient | RelatedPerson | Organization)Individual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownThe annotation - text content (as markdown)
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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.category.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
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.code.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.quantity[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].codepreferredTimingAbbreviation
http://hl7.org/fhir/ValueSet/timing-abbreviation
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.requester.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
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.reasonCode.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
tim-1errorServiceRequest.occurrence[x].repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2errorServiceRequest.occurrence[x].repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-4errorServiceRequest.occurrence[x].repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
tim-5errorServiceRequest.occurrence[x].repeatperiod SHALL be a non-negative value
: period.exists() implies period >= 0
tim-6errorServiceRequest.occurrence[x].repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-7errorServiceRequest.occurrence[x].repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-8errorServiceRequest.occurrence[x].repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-9errorServiceRequest.occurrence[x].repeatIf there's an offset, there must be a when (and not C, CM, CD, CV)
: offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10errorServiceRequest.occurrence[x].repeatIf there's a timeOfDay, there cannot be a when, or vice versa
: timeOfDay.empty() or when.empty()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest ServiceRequest
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patientTransportNeed 0..1codeOptional Extensions Element
URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed
... statusReason 0..*CodeableConceptReason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
Binding: (unbound) (example): Codes identifying the reason for the current state of an event.


... basedOn 0..*Reference(PT_CarePlan)What request fulfills
... requisition 0..1IdentifierComposite Request ID
... status 1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... category 0..1CodeableConceptClassification of service
.... coding 0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required): SNOMED

... priority 0..1coderoutine | urgent | asap | stat
... doNotPerform 0..1booleanTrue if service/procedure should not be performed
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... notPerformReason 0..1CodingExtension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason
.... notPerformDecider 0..1Reference(PT_Practitioner)Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider
... code 0..1CodeableConceptWhat is being requested/ordered
.... coding 0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
... orderDetail 0..*CodeableConceptAdditional order information
... quantity[x] 0..1QuantityService amount
.... value 0..1decimalNumerical value (with implicit precision)
.... unit 0..1stringUnit representation
... subject 1..1Reference(PT_Patient)Individual or Entity the service is ordered for
... encounter 1..1Reference(PT_Encounter)Encounter in which the request was created
... occurrence[x] 0..1TimingWhen service should occur
.... event 0..*dateTimeWhen the event occurs
.... repeat
..... count 0..1positiveIntNumber of times to repeat
... authoredOn 0..1dateTimeDate request signed
... requester 0..1Reference(Device | PT_Practitioner | PT_PractitionerRole)Who/what is requesting service
.... reference 0..1stringLiteral reference, Relative, internal or absolute URL
... performer 0..*Reference(Organization | CareTeam | HealthcareService | PT_Patient | Device | RelatedPerson | PT_Practitioner | PT_PractitionerRole)Requested performer
... locationReference 0..*Reference(PT_Location)Requested location
... reasonCode 0..*CodeableConceptExplanation/Justification for procedure or service
.... coding 0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
... reasonReference 0..*Reference(Observation | DiagnosticReport | DocumentReference | PT_Condition)Explanation/Justification for service or service
... specimen 0..*Reference(PT_Specimen)Procedure Samples
... note
.... author[x] 0..1Reference(Practitioner | Patient | RelatedPerson | Organization)Individual responsible for the annotation
.... text 1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.category.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.code.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.reasonCode.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patientTransportNeed 0..1codeOptional Extensions Element
URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... basedOn Σ0..*Reference(PT_CarePlan)What request fulfills
... requisition Σ0..1IdentifierComposite Request ID
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

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

... category Σ0..1CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required): SNOMED


... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... notPerformReason 0..1CodingExtension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason
.... notPerformDecider 0..1Reference(PT_Practitioner)Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider
... code Σ0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1QuantityService amount
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

.... unit Σ0..1stringUnit representation
... subject Σ1..1Reference(PT_Patient)Individual or Entity the service is ordered for
... encounter Σ1..1Reference(PT_Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1TimingWhen service should occur
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... event Σ0..*dateTimeWhen the event occurs
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Device | PT_Practitioner | PT_PractitionerRole)Who/what is requesting service
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
... performer Σ0..*Reference(Organization | CareTeam | HealthcareService | PT_Patient | Device | RelatedPerson | PT_Practitioner | PT_PractitionerRole)Requested performer
... locationReference Σ0..*Reference(PT_Location)Requested location
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.


.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
... reasonReference Σ0..*Reference(Observation | DiagnosticReport | DocumentReference | PT_Condition)Explanation/Justification for service or service
... specimen Σ0..*Reference(PT_Specimen)Procedure Samples

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
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
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.code.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.quantity[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
ServiceRequest.reasonCode.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patientTransportNeed 0..1codeOptional Extensions Element
URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed
... statusReason 0..*CodeableConceptReason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
Binding: (unbound) (example): Codes identifying the reason for the current state of an event.


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(PT_CarePlan)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

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

... category Σ0..1CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required): SNOMED


.... text Σ0..1stringPlain text representation of the concept
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... notPerformReason 0..1CodingExtension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason
.... notPerformDecider 0..1Reference(PT_Practitioner)Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider
.... value 0..1booleanPrimitive value for boolean
... code Σ0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
.... text Σ0..1stringPlain text representation of the concept
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1QuantityService amount
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

.... unit Σ0..1stringUnit representation
.... system ΣC0..1uriSystem that defines coded unit form
.... code Σ0..1codeCoded form of the unit
... subject Σ1..1Reference(PT_Patient)Individual or Entity the service is ordered for
... encounter Σ1..1Reference(PT_Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1TimingWhen service should occur
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... event Σ0..*dateTimeWhen the event occurs
.... repeat ΣC0..1ElementWhen the event is to occur
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-4: duration SHALL be a non-negative value
tim-5: period SHALL be a non-negative value
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
...... boundsDurationDuration
...... boundsRangeRange
...... boundsPeriodPeriod
..... count Σ0..1positiveIntNumber of times to repeat
..... countMax Σ0..1positiveIntMaximum number of times to repeat
..... duration Σ0..1decimalHow long when it happens
..... durationMax Σ0..1decimalHow long when it happens (Max)
..... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

..... frequency Σ0..1positiveIntEvent occurs frequency times per period
..... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
..... period Σ0..1decimalEvent occurs frequency times per period
..... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
..... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

..... dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
..... timeOfDay Σ0..*timeTime of day for action
..... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


..... offset Σ0..1unsignedIntMinutes from event (before or after)
.... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

... asNeeded[x] Σ0..1Preconditions 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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Device | PT_Practitioner | PT_PractitionerRole)Who/what is requesting service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... performerType Σ0..1CodeableConceptPerformer 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(Organization | CareTeam | HealthcareService | PT_Patient | Device | RelatedPerson | PT_Practitioner | PT_PractitionerRole)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(PT_Location)Requested location
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Snomed Value Set (required)
.... text Σ0..1stringPlain text representation of the concept
... reasonReference Σ0..*Reference(Observation | DiagnosticReport | DocumentReference | PT_Condition)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(PT_Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... note 0..*AnnotationComments
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Reference(Practitioner | Patient | RelatedPerson | Organization)Individual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownThe annotation - text content (as markdown)
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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.category.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
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.code.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.quantity[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.0.1
from the FHIR Standard
ServiceRequest.occurrence[x].codepreferredTimingAbbreviation
http://hl7.org/fhir/ValueSet/timing-abbreviation
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.requester.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
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.reasonCode.codingrequiredSnomedCTVS (a valid code from SNOMED CT)
http://hl7.pt/fhir/core/ValueSet/snomed-ct-vs
from this IG
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
tim-1errorServiceRequest.occurrence[x].repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2errorServiceRequest.occurrence[x].repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-4errorServiceRequest.occurrence[x].repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
tim-5errorServiceRequest.occurrence[x].repeatperiod SHALL be a non-negative value
: period.exists() implies period >= 0
tim-6errorServiceRequest.occurrence[x].repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-7errorServiceRequest.occurrence[x].repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-8errorServiceRequest.occurrence[x].repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-9errorServiceRequest.occurrence[x].repeatIf there's an offset, there must be a when (and not C, CM, CD, CV)
: offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10errorServiceRequest.occurrence[x].repeatIf there's a timeOfDay, there cannot be a when, or vice versa
: timeOfDay.empty() or when.empty()

 

Other representations of profile: CSV, Excel, Schematron