Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

The following is a description of a Service Request that can be submitted to the Community of Information Exchange. 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 for FHIR Service Requests to be grouped together if they where made

https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.requisition

authoredOn

The date and time that this request was created.

https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.authoredOn

identifiers

Represents a array of identifiers for this Service Request. An example would be if the requester has a internal intake id that would be in this list of identifiers.

https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.identifier

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

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

requester

This will be a reference to a 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

subject

This will be a reference to 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

supportingInfo

This will be supporting information about the service request. This will be a reference to a FHIR consent id.

https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.supportingInfo

performer

This will a reference to FHIR resource to the performer of the service. This is usually a organization.

https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.performer

status

The status of the service request.

https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.status

extension

Will be a list of custom attributes that are associated with this ServiceRequest.

note

Any comments associated with this Service Request. This will include the time of the note and the author of the note.

https://build.fhir.org/servicerequest-definitions.html#ServiceRequest.note

  • No labels