NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions

Resource Profile: PH ServiceRequest

Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-ServiceRequest Version: 0.1.0
Standards status: Draft Computable Name: PH_ServiceRequest

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

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

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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())
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest 0..* ServiceRequest A request for a service to be performed
ServiceRequest.meta
ServiceRequest.meta.Slices for extension Content/Rules for all slices
ServiceRequest.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
ServiceRequest.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
ServiceRequest.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
ServiceRequest.implicitRules 0..0 A set of rules under which this content was created
ServiceRequest.language 0..0 Language of the resource content
ServiceRequest.text 0..0 Text summary of the resource, for human interpretation
ServiceRequest.contained 0..0 Contained, inline Resources
ServiceRequest.extension 0..0 Extension
ServiceRequest.modifierExtension 0..0 Extension
ServiceRequest.identifier 0..0 Identifiers assigned to this order
ServiceRequest.instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri 0..0 Instantiates external protocol or definition
ServiceRequest.basedOn 0..0 What request fulfills
ServiceRequest.replaces 0..0 What request replaces
ServiceRequest.requisition 0..0 Composite Request ID
ServiceRequest.category 0..0 Classification of service
ServiceRequest.priority 0..0 routine | urgent | asap | stat
ServiceRequest.doNotPerform 0..0 True if service/procedure should not be performed
ServiceRequest.code 0..0 What is being requested/ordered
ServiceRequest.orderDetail 0..0 Additional order information
ServiceRequest.quantity[x] 0..0 Service amount
ServiceRequest.encounter 0..0 Encounter in which the request was created
ServiceRequest.asNeeded[x] 0..0 Preconditions for service
ServiceRequest.authoredOn 0..0 Date request signed
ServiceRequest.performerType 0..0 Performer role
ServiceRequest.locationCode 0..0 Requested location
ServiceRequest.locationReference 0..0 Requested location
ServiceRequest.insurance 0..0 Associated insurance coverage
ServiceRequest.supportingInfo 0..0 Additional clinical information
ServiceRequest.specimen 0..0 Procedure Samples
ServiceRequest.bodySite 0..0 Location on Body
ServiceRequest.note 0..0 Comments
ServiceRequest.patientInstruction 0..0 Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..0 Request provenance

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.meta.id 0..1 string Unique id for inter-element referencing
ServiceRequest.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
ServiceRequest.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
ServiceRequest.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
ServiceRequest.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
ServiceRequest.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ServiceRequest.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ServiceRequest.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ServiceRequest.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.occurrence[x] This element is included in summaries. 0..1 When service should occur
ServiceRequest.occurrence[x].occurrenceDateTime dateTime
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ServiceRequest.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from ServiceRequest

Summary

Prohibited: 31 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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())
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest 0..* ServiceRequest A request for a service to be performed
ServiceRequest.meta
ServiceRequest.meta.Slices for extension Content/Rules for all slices
ServiceRequest.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
ServiceRequest.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
ServiceRequest.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
ServiceRequest.implicitRules 0..0 A set of rules under which this content was created
ServiceRequest.language 0..0 Language of the resource content
ServiceRequest.text 0..0 Text summary of the resource, for human interpretation
ServiceRequest.contained 0..0 Contained, inline Resources
ServiceRequest.extension 0..0 Extension
ServiceRequest.modifierExtension 0..0 Extension
ServiceRequest.identifier 0..0 Identifiers assigned to this order
ServiceRequest.instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri 0..0 Instantiates external protocol or definition
ServiceRequest.basedOn 0..0 What request fulfills
ServiceRequest.replaces 0..0 What request replaces
ServiceRequest.requisition 0..0 Composite Request ID
ServiceRequest.category 0..0 Classification of service
ServiceRequest.priority 0..0 routine | urgent | asap | stat
ServiceRequest.doNotPerform 0..0 True if service/procedure should not be performed
ServiceRequest.code 0..0 What is being requested/ordered
ServiceRequest.orderDetail 0..0 Additional order information
ServiceRequest.quantity[x] 0..0 Service amount
ServiceRequest.encounter 0..0 Encounter in which the request was created
ServiceRequest.asNeeded[x] 0..0 Preconditions for service
ServiceRequest.authoredOn 0..0 Date request signed
ServiceRequest.performerType 0..0 Performer role
ServiceRequest.locationCode 0..0 Requested location
ServiceRequest.locationReference 0..0 Requested location
ServiceRequest.insurance 0..0 Associated insurance coverage
ServiceRequest.supportingInfo 0..0 Additional clinical information
ServiceRequest.specimen 0..0 Procedure Samples
ServiceRequest.bodySite 0..0 Location on Body
ServiceRequest.note 0..0 Comments
ServiceRequest.patientInstruction 0..0 Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..0 Request provenance

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.meta.id 0..1 string Unique id for inter-element referencing
ServiceRequest.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
ServiceRequest.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
ServiceRequest.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
ServiceRequest.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
ServiceRequest.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ServiceRequest.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ServiceRequest.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ServiceRequest.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.occurrence[x] This element is included in summaries. 0..1 When service should occur
ServiceRequest.occurrence[x].occurrenceDateTime dateTime
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ServiceRequest.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from ServiceRequest

Summary

Prohibited: 31 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron