Dental Data Exchange
2.0.0-ballot - CI Build
Dental Data Exchange
2.0.0-ballot - CI Build
Dental Data Exchange, published by Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/dental-data-exchange/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/dental-data-exchange/dental-servicerequest | Version: 2.0.0-ballot | |||
| Active as of 2024-09-11 | Computable Name: DentalServiceRequest | |||
This profile contains information regarding the dental referral request including an identifier and a reference to the reason for the referral, if possible. It also includes basic information such as the patient, referring provider, and encounter information that resulted in the referral.
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 |
0..* | ServiceRequest | A request for a service to be performed | |
  identifier |
S | 0..* | Identifier | Identifiers assigned to this order |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
| code |
S | 0..1 | CodeableConcept | What is being requested/ordered |
 subject |
1..1 | Reference(US Core Patient Profile(4.0.0)) | Individual or Entity the service is ordered for | |
| encounter |
0..1 | Reference(US Core Encounter Profile(4.0.0)) | Encounter in which the request was created | |
| occurrence[x] |
S | 0..1 | dateTime, Period, Timing | When service should occur |
| reasonCode |
S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: DentalReasonForReferral (preferred) |
| insurance |
S | 0..* | Reference(HRex Coverage Profile) | Associated insurance coverage |
 supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.reasonCode | preferred | DentalReasonForReferralhttp://hl7.org/fhir/us/dental-data-exchange/ValueSet/dental-reason-for-referralfrom 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 |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 0..* | Identifier | Identifiers assigned to this order |
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 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)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. |
| subject |
Σ | 1..1 | Reference(US Core Patient Profile(4.0.0)) | Individual or Entity the service is ordered for |
| encounter |
Σ | 0..1 | Reference(US Core Encounter Profile(4.0.0)) | Encounter in which the request was created |
  occurrence[x] |
SΣ | 0..1 | When service should occur | |
 occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| reasonCode |
SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: DentalReasonForReferral (preferred) |
| insurance |
S | 0..* | Reference(HRex Coverage Profile) | Associated insurance coverage |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| 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.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.reasonCode | preferred | DentalReasonForReferralhttp://hl7.org/fhir/us/dental-data-exchange/ValueSet/dental-reason-for-referralfrom 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 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(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 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)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(US Core Patient Profile(4.0.0)) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(US Core Encounter Profile(4.0.0)) | Encounter in which the request was created | ||||
| occurrence[x] |
SΣ | 0..1 | When service should occur | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
Σ | 0..1 | dateTime | Date request signed | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: DentalReasonForReferral (preferred) | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
S | 0..* | Reference(HRex Coverage Profile) | Associated insurance coverage | ||||
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| 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.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.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom 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 | preferred | DentalReasonForReferralhttp://hl7.org/fhir/us/dental-data-exchange/ValueSet/dental-reason-for-referralfrom 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() |
This structure is derived from ServiceRequest
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
| identifier |
S | 0..* | Identifier | Identifiers assigned to this order |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
| code |
S | 0..1 | CodeableConcept | What is being requested/ordered |
| subject |
1..1 | Reference(US Core Patient Profile(4.0.0)) | Individual or Entity the service is ordered for | |
| encounter |
0..1 | Reference(US Core Encounter Profile(4.0.0)) | Encounter in which the request was created | |
| occurrence[x] |
S | 0..1 | dateTime, Period, Timing | When service should occur |
| reasonCode |
S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: DentalReasonForReferral (preferred) |
| insurance |
S | 0..* | Reference(HRex Coverage Profile) | Associated insurance coverage |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.reasonCode | preferred | DentalReasonForReferralhttp://hl7.org/fhir/us/dental-data-exchange/ValueSet/dental-reason-for-referralfrom 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 |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | Identifiers assigned to this order |
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 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)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. |
| subject |
Σ | 1..1 | Reference(US Core Patient Profile(4.0.0)) | Individual or Entity the service is ordered for |
| encounter |
Σ | 0..1 | Reference(US Core Encounter Profile(4.0.0)) | Encounter in which the request was created |
| occurrence[x] |
SΣ | 0..1 | When service should occur | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| reasonCode |
SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: DentalReasonForReferral (preferred) |
| insurance |
S | 0..* | Reference(HRex Coverage Profile) | Associated insurance coverage |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| 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.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.reasonCode | preferred | DentalReasonForReferralhttp://hl7.org/fhir/us/dental-data-exchange/ValueSet/dental-reason-for-referralfrom 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 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(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 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)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(US Core Patient Profile(4.0.0)) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(US Core Encounter Profile(4.0.0)) | Encounter in which the request was created | ||||
| occurrence[x] |
SΣ | 0..1 | When service should occur | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
Σ | 0..1 | dateTime | Date request signed | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: DentalReasonForReferral (preferred) | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
S | 0..* | Reference(HRex Coverage Profile) | Associated insurance coverage | ||||
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| 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.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.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom 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 | preferred | DentalReasonForReferralhttp://hl7.org/fhir/us/dental-data-exchange/ValueSet/dental-reason-for-referralfrom 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() |
This structure is derived from ServiceRequest
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ Payer/Provider Information Exchange Work Group. Package hl7.fhir.us.dental-data-exchange#2.0.0-ballot based on FHIR 4.0.1. Generated 2024-09-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change