FHIR Service Request

The following is a description of a Service Request that can be submitted to a Community Information Exchange Hub. For detailed information, please visit the HL7 FHIR page https://hl7.org/fhir/us/sdoh-clinicalcare/2022jan/StructureDefinition-SDOHCC-ServiceRequest-definitions.html

Operations

The following are operations that can be performed and links to

Submit a new FHIR service request
Get a FHIR service request by service request id
Change the status of a FHIR service request

Sample Object

{
    resourceType: 'ServiceRequest',
    requisition: {
        use: 'official',
        system: 'https://mi211.org',
        value: '1234567',
    },
    status: 'active',
    intent: 'original-order',
    authoredOn: '2023-08-29T13:56:14.173Z',
    category: [
        {
            coding: [
                {
                    system: 'http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes',
                    code: 'home-visiting',
                    display: 'Home Visiting',
                },
            ],
        },
    ],
    code: {
        coding: [
            {
                system: 'https://211taxonomy.org/',
                code: 'PH-6100.3300',
                display: 'HOME BASED PARENTING EDUCATION',
            },
        ],
    },
    requester: {
        reference: 'Patient/8',
        display: 'Requester Name',
    },
    subject: {
        reference: 'Patient/8',
        display: 'Subject Name',
    },
    supportingInfo: [
        {
            reference: 'Consent/9',
            type: 'Consent',
        },
    ],
    performer: [
        {
            reference: 'HealthcareService/10',
            type: 'HealthcareService',
        },
        {
            reference: 'HealthcareService/11',
            type: 'HealthcareService',
        },
    ],
    extension: [
        {
            url: "https://mi-cie.org/fhir/StructureDefinition/agencyLocation",
            valueString: "name_of_location_here"
        }
    ]
 };

Field Descriptions

The following are descriptions of the fields that must be passed into the service request object.

Field	Description	References
requisition	This will allow multiple FHIR Service Requests to be grouped together if they were made	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.requisition	requisition
authoredOn	The date and time that this request was created.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.authoredOn	authoredOn
identifiers	This field represents an array of identifiers for this Service Request. For example, if the requester has an internal intake ID, it would be included in this list of identifiers.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.identifier	identifier_0_system identifier_0_type_text identifier_0_use identifier_0_value
category	This is the category of the request being made. This represents metadata that will be associated with the Service Request.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.category	category_0_coding_0_code category_0_coding_0_display category_0_coding_0_system
code	This is a code for the service request that is being requested. This code can be one of the following codes LA211 Taxonomy SNOMED Codes LOINC	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.code	code_coding_0_code code_coding_0_display code_coding_0_system
requester	This will be a reference to the FHIR patient record ID or FHIR organization record ID that submitted the FHIR Service Request to the CIE-HUB.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.requester	requester_display requester_organizationId requester_type
subject	This will reference a FHIR patient record id that Service Request is being requested for to the CIE-HUB.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.subject	subject_display subject_patientId
supportingInfo	This will be supporting information about the service request. This will be a reference to an FHIR consent ID.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.supportingInfo
performer	This will be a reference to FHIR resources to the performer of the service. This is usually an organization.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.performer	performer_0_display performer_0_organizationId performer_0_type
status	The status of the service request.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.status	status
extension.createdBySocialNavigator	This is the person who created this ServiceRequest if the ServiceRequest was created inside Social Navigator.		created_by_social_navigator_0_value_string
extension.agencyLocation	This is the location of the agency that is making the ServiceRequest.		agencyLocation_0_value_string
note	This includes any comments associated with this Service Request. This will include the time of the note and its author.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.note	note_x_author_string note_x_text note_x_time
id	The CIE Hub unique identifier for this resource.		id
intent	If the request is a plan or proposal.	https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.intent	intent