HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
0.0.1 - STU1
HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
0.0.1 - STU1
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
| Official URL: http://hl7.pt/fhir/core/StructureDefinition/PTServiceRequest | Version: 0.0.1 | |||
| Active as of 2024-09-23 | Computable Name: PT_ServiceRequest | |||
A generic ServiceRequest resource for Portugal
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest |
ServiceRequest | |||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   patientTransportNeed |
0..1 | code | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed | |
 statusReason |
0..* | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. | |
  identifier |
0..* | Identifier | Identifiers assigned to this order | |
 basedOn |
0..* | Reference(PT_CarePlan) | What request fulfills | |
| requisition |
0..1 | Identifier | Composite Request ID | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
| category |
0..1 | CodeableConcept | Classification of service | |
 coding |
0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required): SNOMED | |
| priority |
0..1 | code | routine | urgent | asap | stat | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 notPerformReason |
0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason | |
| notPerformDecider |
0..1 | Reference(PT_Practitioner) | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider | |
| code |
0..1 | CodeableConcept | What is being requested/ordered | |
| coding |
0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required) | |
| orderDetail |
0..* | CodeableConcept | Additional order information | |
 quantity[x] |
0..1 | Quantity | Service amount | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| subject |
1..1 | Reference(PT_Patient) | Individual or Entity the service is ordered for | |
| encounter |
1..1 | Reference(PT_Encounter) | Encounter in which the request was created | |
| occurrence[x] |
0..1 | Timing | When service should occur | |
| event |
0..* | dateTime | When the event occurs | |
| repeat |
||||
| count |
0..1 | positiveInt | Number of times to repeat | |
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Device | PT_Practitioner | PT_PractitionerRole) | Who/what is requesting service | |
| reference |
0..1 | string | Literal 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..* | CodeableConcept | Explanation/Justification for procedure or service | |
| coding |
0..* | Coding | Code 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..1 | Reference(Practitioner | Patient | RelatedPerson | Organization) | Individual responsible for the annotation | |
| text |
1..1 | markdown | The annotation - text content (as markdown) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.category.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | |
| ServiceRequest.code.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | |
| ServiceRequest.reasonCode.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| patientTransportNeed |
0..1 | code | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed | |
| statusReason |
0..* | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order |
| basedOn |
Σ | 0..* | Reference(PT_CarePlan) | What request fulfills |
| 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 | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| category |
Σ | 0..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required): SNOMED |
| 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| notPerformReason |
0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason | |
| notPerformDecider |
0..1 | Reference(PT_Practitioner) | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider | |
| code |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required) |
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
| quantity[x] |
Σ | 0..1 | Quantity | Service amount |
| value |
Σ | 0..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit |
Σ | 0..1 | string | Unit representation |
| subject |
Σ | 1..1 | Reference(PT_Patient) | Individual or Entity the service is ordered for |
| encounter |
Σ | 1..1 | Reference(PT_Encounter) | Encounter in which the request was created |
| occurrence[x] |
Σ | 0..1 | Timing | When service should occur |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event |
Σ | 0..* | dateTime | When the event occurs |
| authoredOn |
Σ | 0..1 | dateTime | Date request signed |
| requester |
Σ | 0..1 | Reference(Device | PT_Practitioner | PT_PractitionerRole) | Who/what is requesting service |
| reference |
ΣC | 0..1 | string | Literal 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..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| coding |
Σ | 0..* | Coding | Code 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ServiceRequest.code.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | |
| ServiceRequest.quantity[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | |
| ServiceRequest.reasonCode.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 : 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-4 | error | ServiceRequest | If 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-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| patientTransportNeed |
0..1 | code | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed | |||||
| statusReason |
0..* | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(PT_CarePlan) | 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 | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required): SNOMED | ||||
| 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 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| notPerformReason |
0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason | |||||
| notPerformDecider |
0..1 | Reference(PT_Practitioner) | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| code |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required) | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
Σ | 0..1 | Quantity | Service amount | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit |
Σ | 0..1 | string | Unit representation | ||||
| system |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code |
Σ | 0..1 | code | Coded form of the unit | ||||
| subject |
Σ | 1..1 | Reference(PT_Patient) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 1..1 | Reference(PT_Encounter) | Encounter in which the request was created | ||||
| occurrence[x] |
Σ | 0..1 | Timing | When service should occur | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
ΣC | 0..1 | Element | When 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..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| count |
Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period | ||||
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| 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(Device | PT_Practitioner | PT_PractitionerRole) | Who/what is requesting service | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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(Organization | CareTeam | HealthcareService | PT_Patient | Device | RelatedPerson | PT_Practitioner | PT_PractitionerRole) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(PT_Location) | Requested location | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required) | ||||
| text |
Σ | 0..1 | string | Plain 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..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] |
Σ | 0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization) | Individual responsible for the annotation | ||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ServiceRequest.code.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.quantity[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.requester.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.reasonCode.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 : 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-4 | error | ServiceRequest | If 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-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() | |
| tim-1 | error | ServiceRequest.occurrence[x].repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | ServiceRequest.occurrence[x].repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | ServiceRequest.occurrence[x].repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | ServiceRequest.occurrence[x].repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | ServiceRequest.occurrence[x].repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | ServiceRequest.occurrence[x].repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | ServiceRequest.occurrence[x].repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | ServiceRequest.occurrence[x].repeat | If 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-10 | error | ServiceRequest.occurrence[x].repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from ServiceRequest
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
ServiceRequest | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| patientTransportNeed |
0..1 | code | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed | |
| statusReason |
0..* | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. | |
| identifier |
0..* | Identifier | Identifiers assigned to this order | |
| basedOn |
0..* | Reference(PT_CarePlan) | What request fulfills | |
| requisition |
0..1 | Identifier | Composite Request ID | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
| category |
0..1 | CodeableConcept | Classification of service | |
| coding |
0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required): SNOMED | |
| priority |
0..1 | code | routine | urgent | asap | stat | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| notPerformReason |
0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason | |
| notPerformDecider |
0..1 | Reference(PT_Practitioner) | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider | |
| code |
0..1 | CodeableConcept | What is being requested/ordered | |
| coding |
0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required) | |
| orderDetail |
0..* | CodeableConcept | Additional order information | |
| quantity[x] |
0..1 | Quantity | Service amount | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| unit |
0..1 | string | Unit representation | |
| subject |
1..1 | Reference(PT_Patient) | Individual or Entity the service is ordered for | |
| encounter |
1..1 | Reference(PT_Encounter) | Encounter in which the request was created | |
| occurrence[x] |
0..1 | Timing | When service should occur | |
| event |
0..* | dateTime | When the event occurs | |
| repeat |
||||
| count |
0..1 | positiveInt | Number of times to repeat | |
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Device | PT_Practitioner | PT_PractitionerRole) | Who/what is requesting service | |
| reference |
0..1 | string | Literal 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..* | CodeableConcept | Explanation/Justification for procedure or service | |
| coding |
0..* | Coding | Code 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..1 | Reference(Practitioner | Patient | RelatedPerson | Organization) | Individual responsible for the annotation | |
| text |
1..1 | markdown | The annotation - text content (as markdown) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.category.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | |
| ServiceRequest.code.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | |
| ServiceRequest.reasonCode.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| patientTransportNeed |
0..1 | code | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed | |
| statusReason |
0..* | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order |
| basedOn |
Σ | 0..* | Reference(PT_CarePlan) | What request fulfills |
| 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 | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| category |
Σ | 0..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required): SNOMED |
| 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| notPerformReason |
0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason | |
| notPerformDecider |
0..1 | Reference(PT_Practitioner) | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider | |
| code |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required) |
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
| quantity[x] |
Σ | 0..1 | Quantity | Service amount |
| value |
Σ | 0..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit |
Σ | 0..1 | string | Unit representation |
| subject |
Σ | 1..1 | Reference(PT_Patient) | Individual or Entity the service is ordered for |
| encounter |
Σ | 1..1 | Reference(PT_Encounter) | Encounter in which the request was created |
| occurrence[x] |
Σ | 0..1 | Timing | When service should occur |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event |
Σ | 0..* | dateTime | When the event occurs |
| authoredOn |
Σ | 0..1 | dateTime | Date request signed |
| requester |
Σ | 0..1 | Reference(Device | PT_Practitioner | PT_PractitionerRole) | Who/what is requesting service |
| reference |
ΣC | 0..1 | string | Literal 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..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| coding |
Σ | 0..* | Coding | Code 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ServiceRequest.code.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | |
| ServiceRequest.quantity[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | |
| ServiceRequest.reasonCode.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 : 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-4 | error | ServiceRequest | If 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-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| patientTransportNeed |
0..1 | code | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/PatientTransportNeed | |||||
| statusReason |
0..* | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(PT_CarePlan) | 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 | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required): SNOMED | ||||
| 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 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| notPerformReason |
0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformReason | |||||
| notPerformDecider |
0..1 | Reference(PT_Practitioner) | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/NotPerformDecider | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| code |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required) | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
Σ | 0..1 | Quantity | Service amount | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit |
Σ | 0..1 | string | Unit representation | ||||
| system |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code |
Σ | 0..1 | code | Coded form of the unit | ||||
| subject |
Σ | 1..1 | Reference(PT_Patient) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 1..1 | Reference(PT_Encounter) | Encounter in which the request was created | ||||
| occurrence[x] |
Σ | 0..1 | Timing | When service should occur | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
ΣC | 0..1 | Element | When 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..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| count |
Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period | ||||
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| 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(Device | PT_Practitioner | PT_PractitionerRole) | Who/what is requesting service | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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(Organization | CareTeam | HealthcareService | PT_Patient | Device | RelatedPerson | PT_Practitioner | PT_PractitionerRole) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(PT_Location) | Requested location | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: Snomed Value Set (required) | ||||
| text |
Σ | 0..1 | string | Plain 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..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] |
Σ | 0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization) | Individual responsible for the annotation | ||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ServiceRequest.code.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.quantity[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x].code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.requester.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.reasonCode.coding | required | SnomedCTVS (a valid code from SNOMED CT)http://hl7.pt/fhir/core/ValueSet/snomed-ct-vsfrom this IG | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 : 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-4 | error | ServiceRequest | If 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-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() | |
| tim-1 | error | ServiceRequest.occurrence[x].repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | ServiceRequest.occurrence[x].repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | ServiceRequest.occurrence[x].repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | ServiceRequest.occurrence[x].repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | ServiceRequest.occurrence[x].repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | ServiceRequest.occurrence[x].repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | ServiceRequest.occurrence[x].repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | ServiceRequest.occurrence[x].repeat | If 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-10 | error | ServiceRequest.occurrence[x].repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from ServiceRequest
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron