Copyright 2024 Brightstreet Group
The following is a description of a Service Request that can be submitted to the a Community of 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
...
The following are operations that can be performed and links to
Change the status of a FHIR service request
Sample Object
Code Block |
---|
{ resourceType: 'ServiceRequest', requisition: { use: 'official', system: 'https://mi211.org', value: '1234567', }, status: 'active', intent: 'original-order', authoredOn: '2023-08-29T13:56:14.173Z', category"authoredOn": "2024-07-26T00:00:00.000Z", "category": [ { { "coding": [ coding:{ [ "code": "GeneratedExcelSpreadsheet_v2", { "display": "Generated by Excel Spreadsheet", "system": 'http"https://hl7mi-cie.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes', code: 'home-visiting', display: 'Home Visiting', StructureDefinition" }, ], }, ], "code": { "coding": [ { system: 'https://211taxonomy.org/', code: 'PH-6100.3300'"code": "83977-9", display: 'HOME BASED PARENTING EDUCATION'"display": "Social worker Outreach note", "system": "https://loinc.org" }, } ], }, requester: { reference: 'Patient/8', display: 'Requester Name', }, subject"id": "895852ed-1234-4864-988a-bd114cc56ff5", "intent": "original-order", "meta": { reference: 'Patient/8'"lastUpdated": "2024-07-31T14:10:19.489195+00:00", display"versionId": 'Subject Name',"MTcyMjQzNTAxOTQ4OTE5NTAwMA" }, supportingInfo"performer": [ { { "display": "Michigan 211 Gryphon Place", "reference": 'Consent/9'"Organization/MI211-GRYP", type: 'Consent', "type": "Organization" }, ], performer"requester": [{ "display": "Children’s Services Agency {(CSA)", reference: 'HealthcareService/10', type: 'HealthcareService', }, { reference: 'HealthcareService/11', type: 'HealthcareService', }, ], extension: [ { url: "https://mi-cie.org/fhir/StructureDefinition/agencyLocation"reference": "Organization/CSA" }, "resourceType": "ServiceRequest", "status": "active", "subject": { "display": "FIRSTNAME LASTNAME", valueString: "name_of_location_here" } ] }; "reference": "Patient/123484f8-40bf-4b1c-acfe-df60bef055f2" } } |
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
| 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 |
status
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 |