FHIR Extensions

Welcome to Health Gorilla's Developer Portal. Access API documentation for our suite of clinical data APIs.

HealthGorilla uses the FHIR Extensions mechanism to define additional attributes.
See: https://hl7.org/fhir/STU3/defining-extensions.html

Worker Compensation

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/account-wc
Status: active.
Extension maintained by: Health Gorilla
The Worker Compensation property.
Context of Use: Use on element: Account

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Boolean

URL = https://www.healthgorilla.com/fhir/StructureDefinition/account-wc
Worker Compensation: True if worker compensation applied.
Use on element: Account

Request Group - Account

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-account
Status: active.
Extension maintained by: Health Gorilla
Bill to the specified account.
Context of Use: Use on element: RequestGroup

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Reference(Account)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-account
Account: Bill to the specified account.
Use on element: RequestGroup

Patient Location

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/patient-location
Status: active.
Extension maintained by: Health Gorilla
The current location of the patient - room/bed, facility.
Context of Use: Use on element: RequestGroup, Patient, DiagnosticReport

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Reference(Location)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/patient-location
Location: The current location of the patient.
Use on element: RequestGroup, Patient, DiagnosticReport

Related Person Employer

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/relatedperson-employer
Status: active.
Extension maintained by: Health Gorilla
The employer of the given person.
Context of Use: Use on element: RelatedPerson

Name

Flags

Card

Type

Description & Constraints

extension

0..1

String

URL = https://www.healthgorilla.com/fhir/StructureDefinition/relatedperson-employer
Employer: The employer of the patient.
Use on element: RelatedPerson

Record Recorder

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/record-recorder
Status: active.
Extension maintained by: Health Gorilla
The individual who recorded the record and takes responsibility for its content.
Context of Use: Use on element: Procedure, MedicationStatement, FamilyMemberHistory, Encounter, CarePlan

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Reference(Practitioner)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/record-recorder
Practitioner: Individual who recorded the record and takes responsibility for its content.
Use on element: Procedure, MedicationStatement, FamilyMemberHistory, Encounter, CarePlan

RequestGroup - Performer

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-performer
Status: active.
Extension maintained by: Health Gorilla
The desired performer for doing the diagnostic testing.
Context of Use: Use on element: RequestGroup

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Reference(Organization)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-performer
Organization: The desired performer for doing the diagnostic testing.
Use on element: RequestGroup

RequestGroup - Requester

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-requester
Status: active.
Extension maintained by: Health Gorilla
Who/what is requesting the diagnostic procedure.
Context of Use: Use on element: RequestGroup

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Extension

URL = https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-requester

Use on element: RequestGroup

agent

1..1

Reference(Practitioner)

Practitioner: The practitioner who initiated the request.

onBehalfOf

1..1

Reference(Organization)

Organization: The organization the practitioner was acting on behalf of.

...
<extension url="https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-requester">
        <extension url="agent">
            <valueReference>
                <reference value="#practitioner"/>
            </valueReference>
        </extension>
        <extension url="onBehalfOf">
            <valueReference>
                <reference value="#organization"/>
            </valueReference>
        </extension>
    </extension>
...

RequestGroup - ReasonCode

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-reasoncode
Status: active.
Extension maintained by: Health Gorilla
An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes.
Context of Use: Use on element: RequestGroup

Name

Flags

Card

Type

Description & Constraints

extension

0..*

CodeableConcept

URL = https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-reasoncode
ReasonCode: Explanation/Justification for request.
Use on element: RequestGroup

RequestGroup - Specimen

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-specimen
Status: active.
Extension maintained by: Health Gorilla
One or more specimens that the laboratory procedure will use.
Context of Use: Use on element: RequestGroup

Name

Flags

Card

Type

Description & Constraints

extension

0..*

Reference(Specimen)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-specimen
Specimen: Procedure Samples
Use on element: RequestGroup

RequestGroup - AuthorizedBy

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-authorizedBy
Status: active.
Extension maintained by: Health Gorilla
The organization who authorized the order.
Context of Use: Use on element: RequestGroup

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Reference(Organization)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-authorizedBy
Organization: Authorizer of the order.
Use on element: RequestGroup

RequestGroup - DeliveryOptions

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-deliveryOptions
Status: draft.
Extension maintained by: Health Gorilla
Delivery options for the given order.
Context of Use: Use on element: RequestGroup

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Extension

URL = https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-deliveryOptions

Use on element: RequestGroup

location

0..1

Reference(Location)

Location: The location that receives the requisition.

method

0..1

ContactPoint

Method: How the given order should be delivered to the certain location - by fax, by email etc.

electronic

0..1

Boolean

Electronic: If True then submit order electronically.

Performer - Location

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/performer-location
Status: active.
Extension maintained by: Health Gorilla
Facility location that processes the given order.
Context of Use: Use on element: RequestGroup

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Reference(Location)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/performer-location

Location: Facility location that processes the given order.
Use on element: RequestGroup

Operationoutcome - OrderSplitting

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/operationoutcome-order-splitting
Status: active.
Extension maintained by: Health Gorilla
Contains tests grouped in the particular way.
Context of Use: Use on element: OperationOutcome

Name

Flags

Card

Type

Description & Constraints

extension

0..1

String

URL = https://www.healthgorilla.com/fhir/StructureDefinition/operationoutcome-order-splitting

groupedTests: contains tests grouped in way they can be submitted
Example: 009001|488162;500199
Use on element: OperationOutcome

Provider Compendium

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/provider-compendium
Status: active.
Extension maintained by: Health Gorilla
Refers to the set of tests that can be ordered in the given HealthCare Provider.
Context of Use: Use on element: Organization, Location

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Reference(ValueSet)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/provider-compendium

compendium: link to the set of test supported.
Use on element: Organization, Location

Questionnaire - RequiredWhenSpecimenCollected

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/questionnaire-requiredwhenspecimen
Status: active.
Extension maintained by: Health Gorilla
Indicates that AOE answer is required, if a specimen has been collected.
Context of Use: Use on element: Questionnaire.item

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Boolean

URL = https://www.healthgorilla.com/fhir/StructureDefinition/questionnaire-requiredwhenspecimen

required: AOE answer required
Use on element: Questionnaire.item

Questionnaire - Constraints

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/questionnaire-constraints
Status: active.
Extension maintained by: Health Gorilla
Contains different constraints related to the given AOE.
Context of Use: Use on element: Questionnaire.item

Name

Flags

Card

Type

Description & Constraints

extension

0..1

String

URL = https://www.healthgorilla.com/fhir/StructureDefinition/questionnaire-constraints

constraints: details
Use on element: Questionnaire.item

Diagnostic Report - Fasting

https://www.healthgorilla.com/fhir/StructureDefinition/diagnosticreport-fasting

Status: active. Extension maintained by: Health Gorilla

The Fasting status of Diagnostic Report.

Context of Use: Use on element: DiagnosticReport

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Boolean

URL = https://www.healthgorilla.com/fhir/StructureDefinition/diagnosticreport-fasting

Fasting Status: True if patient was fasting.

Use on element: DiagnosticReport

Diagnostic Report - Interpretation

https://www.healthgorilla.com/fhir/StructureDefinition/diagnosticreport-interpretation

Status: active. Extension maintained by: Health Gorilla

A categorical assessment of a laboratory report (known as 'abnormal flag').

Context of Use: Use on element: DiagnosticReport

Name

Flags

Card.

Type

Description & Constraints

extension

0..1

CodeableConcept

URL = https://www.healthgorilla.com/fhir/StructureDefinition/diagnosticreport-interpretation

Interpretation: A categorical assessment of a laboratory report (known as 'abnormal flag').

Binding: FHIR DiagnosticReport Interpretation (required)

Use on element: DiagnosticReport

Diagnostic Report - Reporting Priority

https://www.healthgorilla.com/fhir/StructureDefinition/diagnosticreport-reportingPriority

Status: active. Extension maintained by: Health Gorilla

A set of codes that describe the urgency at which the report should be given to the clinician.

Context of Use: Use on element: DiagnosticReport

Name

Flags

Card.

Type

Description & Constraints

extension

0..1

CodeableConcept

URL = https://www.healthgorilla.com/fhir/StructureDefinition/diagnosticreport-reportingPriority

Reporting Priority: A set of codes that describe the urgency at which the report should be given to the clinician.

Binding: FHIR DiagnosticReport Reporting Priority (required)

Use on element: DiagnosticReport

DocumentReference - On-Demand

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/documentreference-ondemand
Status: active.
Extension maintained by: Health Gorilla
Indicates that this is a IHE ITI On-Demand Document.
Context of Use: Use on element: DocumentReference

Name

Flags

Card

Type

Description & Constraints

extension

0..1

String

URL = https://www.healthgorilla.com/fhir/StructureDefinition/documentreference-ondemand

On-Demand: True if this is a dynamically generated document.
Use on element: DocumentReference

ReferralRequest - Recipient

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-recipient
Status: active.
Extension maintained by: Health Gorilla
Who is the recipient of the referral.
Context of Use: Use on element: ReferralRequest

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Extension

URL = https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-recipient

Use on element: ReferralRequest

agent

1..1

Reference(Practitioner)

Practitioner: The practitioner who should receive the request.

location

0..1

Reference(Location)

Location: The location at which this practitioner provides care.

onBehalfOf

1..1

Reference(Organization)

Organization: The organization the practitioner was acting on behalf of.

{
  "url":"https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-recipient",
  "extension": [
  {
    "url": "agent",
    "valueReference": {
        "reference": "Practitioner/974e04546c424b6f687bf587",
      "display": "Dr. John Michael Doe"
    }
  },
  {
    "url": "onBehalfOf",
    "valueReference": {
        "reference": "Organization/t-974e04549053f5b7257b292c",
        "display": "Sacred Heart  Hospital"
    }
    }
  ]
}

ReferralRequest - Reply

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-reply
Status: active.
Extension maintained by: Health Gorilla
The reply on the incoming referral.
Context of Use: Use on element: ReferralRequest

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Reference(DirectMessage)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-reply

DirectMessage: The response.
Use on element: ReferralRequest

{
    "url":"https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-reply",
    "valueReference": {
        "identifier": {
            "system": "https://www.healthgorilla.com",
            "value": "f2cbc35ee0ea0223658835ba"
        }
    }
}

ReferralRequest - DeliveryOptions

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-deliveryOptions
Status: draft.
Extension maintained by: Health Gorilla
Delivery options for the given referral.
Context of Use: Use on element: ReferralRequest

Name

Flags

Card

Type

Description & Constraints

extension

0..1

Extension

URL = https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-deliveryOptions

Use on element: ReferralRequest

method

0..*

ContactPoint

Method: How the given referral should be delivered to the recipient - by fax, by email, by SMS etc.

{
    "url": "https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-deliveryOptions",
    "extension": [
   {
        "url": "method",
      "valueContactPoint": {
        "system": "fax",
            "value": "000 000 0000"
      }
    },
    {
        "url": "method",
      "valueContactPoint": {
        "system": "email",
        "value": "[email protected]"
     }
    },
    {
        "url": "method",
      "valueContactPoint": {
        "system": "sms",
        "value": "+1 000 000 0000"
      }
    }
    ]
}

Observation - Reflected By

URL for this extension: https://www.healthgorilla.com/fhir/StructureDefinition/observation-reflectedBy
Status: draft.
Extension maintained by: Health Gorilla
Indicates that this is a lab-generated result for test not on the original order. Contains reference to observation that reflexes creating this lab-generated order.
Context of Use: Use on element: Observation (observation group)

Name

Flags

Card

Type

Description & Constraints

reflectedBy

0..1

Reference(Observation)

URL = https://www.healthgorilla.com/fhir/StructureDefinition/observation-reflectedBy

reflectedBy: This observation reflexes creating this lab-generated order.

Use on element: Observation

{
   "url":"https://www.healthgorilla.com/fhir/StructureDefinition/observation-reflectedBy",
   "valueReference":{
      "reference":"Observation/sampleb5bcd352fa66d608668c9d0d-2-1",
      "display":"SODIUM, SERUM"
   }
}

Subscription - Channel Secret

URL for this extension:https://www.healthgorilla.com/fhir/StructureDefinition/subscription-channelSecret
Extension maintained by: Health Gorilla
In order to further secure Subscription notifications we added a HMAC-SHA signature capability to the request to provide both data integrity and the authenticity of a message.

Parameter Name

Description

Is Required?

value

signing secret, random 32 character length hex string

Yes

id

secret identifier

No

end

valid until, datetime

No

{
    "url":
  "https://www.healthgorilla.com/fhir/StructureDefinition/subscription-channelSecret",
  "extension": [
    {
        "url": "value",
        "valueString": "my-signing-key"
    },
    {
      "url": "id",
      "valueString": "key-1"
    },
    {
      "url": "end",
      "valueDateTime": "2022-02-02T02:02:02+03:00"
    }
  ]
}