Profiles & Operations > Structure Definition: ServiceRequest Profile

Profile: ServiceRequest

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-servicerequest

Simplifier project page: MHA ServiceRequest Profile

Derived from: ServiceRequest (R4)

Formal Views of Profile Content

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

Differential View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
referralTypeS I0..1Extension(CodeableConcept)
referralSourceTypeS I0..1Extension(CodeableConcept)
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriBinding
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..*uri
basedOnΣ I0..*Reference(CarePlan | ServiceRequest | MedicationRequest)
replacesΣ I0..*Reference(ServiceRequest)
requisitionΣ0..1Identifier
statusS Σ ?!1..1codeBinding
intentS Σ ?!1..1codeBinding
categoryΣ0..*CodeableConceptBinding
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
orderDetailΣ I0..*CodeableConcept
quantityQuantityQuantity
quantityRatioRatio
quantityRangeRange
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterS Σ I0..1Reference(Encounter)
occurrenceDateTimedateTime
occurrencePeriodPeriod
occurrenceTimingTiming
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
authoredOnS Σ0..1dateTime
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
performerTypeΣ0..1CodeableConcept
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
locationCodeΣ0..*CodeableConcept
locationReferenceS Σ I0..*Reference(MHA Location Profile)
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)
insuranceI0..*Reference(Coverage | ClaimResponse)
supportingInfoI0..*Reference(Resource)
specimenΣ I0..*Reference(Specimen)
bodySiteΣ0..*CodeableConcept
note0..*Annotation
patientInstructionΣ0..1string
relevantHistoryI0..*Reference(Provenance)

Hybrid View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
referralTypeS I0..1Extension(CodeableConcept)
referralSourceTypeS I0..1Extension(CodeableConcept)
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriBinding
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..*uri
basedOnΣ I0..*Reference(CarePlan | ServiceRequest | MedicationRequest)
replacesΣ I0..*Reference(ServiceRequest)
requisitionΣ0..1Identifier
statusS Σ ?!1..1codeBinding
intentS Σ ?!1..1codeBinding
categoryΣ0..*CodeableConceptBinding
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
orderDetailΣ I0..*CodeableConcept
quantityQuantityQuantity
quantityRatioRatio
quantityRangeRange
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterS Σ I0..1Reference(Encounter)
occurrenceDateTimedateTime
occurrencePeriodPeriod
occurrenceTimingTiming
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
authoredOnS Σ0..1dateTime
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
performerTypeΣ0..1CodeableConcept
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
locationCodeΣ0..*CodeableConcept
locationReferenceS Σ I0..*Reference(MHA Location Profile)
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)
insuranceI0..*Reference(Coverage | ClaimResponse)
supportingInfoI0..*Reference(Resource)
specimenΣ I0..*Reference(Specimen)
bodySiteΣ0..*CodeableConcept
note0..*Annotation
patientInstructionΣ0..1string
relevantHistoryI0..*Reference(Provenance)

Snapshot View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
referralTypeS I0..1Extension(CodeableConcept)
referralSourceTypeS I0..1Extension(CodeableConcept)
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriBinding
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..*uri
basedOnΣ I0..*Reference(CarePlan | ServiceRequest | MedicationRequest)
replacesΣ I0..*Reference(ServiceRequest)
requisitionΣ0..1Identifier
statusS Σ ?!1..1codeBinding
intentS Σ ?!1..1codeBinding
categoryΣ0..*CodeableConceptBinding
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
orderDetailΣ I0..*CodeableConcept
quantityQuantityQuantity
quantityRatioRatio
quantityRangeRange
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterS Σ I0..1Reference(Encounter)
occurrenceDateTimedateTime
occurrencePeriodPeriod
occurrenceTimingTiming
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
authoredOnS Σ0..1dateTime
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
performerTypeΣ0..1CodeableConcept
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)
locationCodeΣ0..*CodeableConcept
locationReferenceS Σ I0..*Reference(MHA Location Profile)
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)
insuranceI0..*Reference(Coverage | ClaimResponse)
supportingInfoI0..*Reference(Resource)
specimenΣ I0..*Reference(Specimen)
bodySiteΣ0..*CodeableConcept
note0..*Annotation
patientInstructionΣ0..1string
relevantHistoryI0..*Reference(Provenance)

Table View

ServiceRequest..
ServiceRequest.meta1..
ServiceRequest.meta.profile1..1
ServiceRequest.extension0..
ServiceRequest.extensionExtension0..1
ServiceRequest.extensionExtension0..
ServiceRequest.identifier..1
ServiceRequest.identifier.system1..
ServiceRequest.identifier.value1..
ServiceRequest.status..
ServiceRequest.intent..
ServiceRequest.category..
ServiceRequest.code..
ServiceRequest.code.coding..
ServiceRequest.code.coding..
ServiceRequest.code.coding.system1..
ServiceRequest.code.coding.code1..
ServiceRequest.code.coding..
ServiceRequest.code.coding.system1..
ServiceRequest.code.coding.code1..
ServiceRequest.subjectReference(MHA Patient Profile)..
ServiceRequest.subject.reference1..
ServiceRequest.encounter..
ServiceRequest.authoredOn..
ServiceRequest.requesterReference(MHA Patient Profile | MHA Organization Profile)..
ServiceRequest.requester.reference1..
ServiceRequest.locationReferenceReference(MHA Location Profile)..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "profile-servicerequest",
    "meta": {
        "versionId": "2",
        "lastUpdated": "2022-08-05T17:22:51.6015866+00:00"
    },
    "text": {
        "status": "extensions",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-servicerequest",
    "version": "1.0.0",
    "name": "ServiceRequestProfile",
    "title": "MHA ServiceRequest Profile",
    "status": "active",
    "date": "2022-08-05T17:24:30.5070217+00:00",
    "publisher": "HL7 Canada - FHIR Implementation Work Group",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "https://infocentral.infoway-inforoute.ca/en/collaboration/wg/fhir-implementations"
                }
            ]
        }
    ],
    "description": "Proposed constraints on the ServiceRequest resource for the minimal set of data required to request for service such as diagnostic investigations, treatments, or operations to be performed",
    "jurisdiction":  [
        {
            "coding":  [
                {
                    "system": "urn:iso:std:iso:3166",
                    "code": "CA"
                }
            ]
        }
    ],
    "purpose": "This profile will capture information related to the client referral.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "quick",
            "uri": "http://siframework.org/cqf",
            "name": "Quality Improvement and Clinical Knowledge (QUICK)"
        },
        {
            "identity": "MHA-PDS-Mapping",
            "name": "MHA PDS Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "ServiceRequest",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ServiceRequest",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ServiceRequest",
                "path": "ServiceRequest",
                "short": "ServiceRequest Profile",
                "definition": "Service Request Profile is based upon the core FHIR ServiceRequest resource and created to define the minimal set of data required to request for service such as diagnostic investigations, treatments, or operations to be performed.",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "MHA-PDS-Mapping",
                        "map": "MHA PDS Mapping"
                    }
                ]
            },
            {
                "id": "ServiceRequest.meta",
                "path": "ServiceRequest.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.meta.profile",
                "path": "ServiceRequest.meta.profile",
                "min": 1,
                "max": "1",
                "fixedCanonical": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-servicerequest",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.extension",
                "path": "ServiceRequest.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "ServiceRequest.extension:referralType",
                "path": "ServiceRequest.extension",
                "sliceName": "referralType",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-ext-ReferralType"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.extension:referralSourceType",
                "path": "ServiceRequest.extension",
                "sliceName": "referralSourceType",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ext-referralSourceType"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.identifier",
                "path": "ServiceRequest.identifier",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.identifier.system",
                "path": "ServiceRequest.identifier.system",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "description": "The identifier URIs for referrals",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/mha/ServiceRequest-identifier-system"
                }
            },
            {
                "id": "ServiceRequest.identifier.value",
                "path": "ServiceRequest.identifier.value",
                "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.\nUniquely identifies a client referral to an organization for a specific program / service.",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "MHA-PDS-Mapping",
                        "map": "Referral ID"
                    }
                ]
            },
            {
                "id": "ServiceRequest.status",
                "path": "ServiceRequest.status",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.intent",
                "path": "ServiceRequest.intent",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.category",
                "path": "ServiceRequest.category",
                "definition": "A code that classifies the service for searching, sorting and display purposes (e.g. Surgical Procedure).",
                "binding": {
                    "strength": "preferred"
                }
            },
            {
                "id": "ServiceRequest.code.coding",
                "path": "ServiceRequest.code.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.code.coding:LabOrder",
                "path": "ServiceRequest.code.coding",
                "sliceName": "LabOrder",
                "short": "Laboratory procedure code",
                "definition": "A code that identifies a laboratory procedure that have been requested",
                "comment": "The binding strength of this element is [Preferred](https://www.hl7.org/fhir/terminologies.html#strength), meaning that codes are encouraged to draw from the pCLOCD value set for interoperability purposes but are not required to do so to be considered conformant.",
                "binding": {
                    "strength": "preferred",
                    "description": "The pan Canadian LOINC Observation Code Database (pCLOCD) is the Canadian version of the LOINC(tm) database. It was created using the LOINC(tm) records and attributes that were constrained for Canadian use and supplemented to specifically meet Canadian requirements. It contains the core LOINC(tm) attributes as required by Regenstrief copyright rules. The LOINC(tm) Component has been customized to meet Canadian requirements and is displayed as the pan Canadian Component Name. This component name is the basis for the pan Canadian Display Name. Core attributes are include both English and Canadian French.",
                    "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/pCLOCD"
                }
            },
            {
                "id": "ServiceRequest.code.coding:LabOrder.system",
                "path": "ServiceRequest.code.coding.system",
                "min": 1
            },
            {
                "id": "ServiceRequest.code.coding:LabOrder.code",
                "path": "ServiceRequest.code.coding.code",
                "min": 1
            },
            {
                "id": "ServiceRequest.code.coding:@default",
                "path": "ServiceRequest.code.coding",
                "sliceName": "@default"
            },
            {
                "id": "ServiceRequest.code.coding:@default.system",
                "path": "ServiceRequest.code.coding.system",
                "min": 1
            },
            {
                "id": "ServiceRequest.code.coding:@default.code",
                "path": "ServiceRequest.code.coding.code",
                "min": 1
            },
            {
                "id": "ServiceRequest.subject",
                "path": "ServiceRequest.subject",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.subject.reference",
                "path": "ServiceRequest.subject.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.encounter",
                "path": "ServiceRequest.encounter",
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.authoredOn",
                "path": "ServiceRequest.authoredOn",
                "definition": "The date when the referral was received by organization for a specific program / service.",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "MHA-PDS-Mapping",
                        "map": "Referral Received Date"
                    }
                ]
            },
            {
                "id": "ServiceRequest.requester",
                "path": "ServiceRequest.requester",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-patient",
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ServiceRequest.requester.reference",
                "path": "ServiceRequest.requester.reference",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "MHA-PDS-Mapping",
                        "map": "Referral Source"
                    }
                ]
            },
            {
                "id": "ServiceRequest.locationReference",
                "path": "ServiceRequest.locationReference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-location"
                        ]
                    }
                ],
                "mustSupport": true
            }
        ]
    }
}

Usage

The ServiceRequest resource is a record of a request on behalf of a client for health care services related to mental health and addictions.

Notes

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-servicerequest
.meta.versionId

  • SHALL be populated by the OH FHIR server
  • source systems do not need to populate this element prior to submission
.extension.ReferralType.value.coding.code

  • SHOULD contain a code indicating the type of referral (e.g., initial (external) or internal).
extension.ReferralSourceType.value.coding.code

  • SHOULD contain a code from the referenced value set indicating where the referral came from.
.identifier.value

  • SHOULD contain a unique identifier of a client referral to an organization for a specific program / service.
.status

  • SHALL contain a code from the value set to which this element is bound.
  • The value selected best represents the status of the service request. If this value cannot be determined, this field is to be populated with the code unknown
.intent

  • SHALL contain a code from the value set to which this element is bound.
  • The value selected best represents the intent of the service request. If this value cannot be determined, this field is to be populated with the code plan
.authoredOn

  • SHOULD contain the date when the referral was received by organization for a specific program / service.
.requester.reference

  • SHALL contain a reference URL to the agency, organization or individual (including self-referral) that referred the client for treatment to the agency providing the services.
  • For self referral, include a URL to the patient resource.
  • For referral from another organization, include a URL to the organization resource.