API Reference

FHIR Extensions

Health Gorilla uses the FHIR Extensions mechanism to define additional attributes on FHIR resources when standard FHIR elements do not capture the required information.

Extension Usage Pattern

Extensions are included in FHIR resources using the extension element.

Example:

{
  "extension": [
    {
      "url": "https://www.healthgorilla.com/fhir/StructureDefinition/account-wc",
      "valueBoolean": true
    }
  ]
}

Account Extensions

Worker Compensation

Indicates whether workers’ compensation applies to the account.

RequestGroup Extensions

RequestGroup – Account

Specifies the account that should be billed for the order.

RequestGroup – Performer

Specifies the organization that should perform the diagnostic testing.

RequestGroup – Requester

Identifies the practitioner requesting the diagnostic procedure and the organization on whose behalf the request is made.

Child Elements

FieldTypeCardDescription
agentReference(Practitioner)1..1Practitioner initiating the request
onBehalfOfReference(Organization)1..1Organization on whose behalf the request is made

Example:

<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

Provides a coded or textual explanation for why the diagnostic request was submitted.

RequestGroup – Specimen

Specifies the specimen or specimens required for the diagnostic procedure.

RequestGroup – AuthorizedBy

Identifies the organization that authorized the order.

RequestGroup – DeliveryOptions

Specifies how an order should be delivered to the receiving location.

Child Elements

FieldTypeCardDescription
locationReference(Location)0..1Receiving facility
methodContactPoint0..1Delivery method
electronicBoolean0..1Submit order electronically

RequestGroup – SupervisingProvider

Adds a supervising provider electronic signature to a lab requisition.

Patient Extensions

Patient Location

Identifies the patient's current location, such as room, bed, or facility.

RelatedPerson Extensions

RelatedPerson – Employer

Specifies the employer of the related person.

DiagnosticReport Extensions

DiagnosticReport – Fasting

Indicates whether the patient was fasting when the diagnostic report was generated.

DiagnosticReport – Interpretation

Provides a categorical interpretation of the diagnostic result (abnormal flag).

Binding:

FHIR DiagnosticReport Interpretation Value Set
https://developer.healthgorilla.com/docs/fhir-value-sets#diagnostic-report-interpretation

DiagnosticReport – Reporting Priority

Indicates the urgency with which the report should be communicated.

Binding:

FHIR DiagnosticReport Reporting Priority Value Set
https://developer.healthgorilla.com/docs/fhir-value-sets#diagnostic-report-reporting-priority

Observation Extensions

Observation – ReflectedBy

Indicates that the observation was generated as a result of a reflex test triggered by another observation.

Example:

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

DocumentReference Extensions

DocumentReference – On-Demand

Indicates that the document is dynamically generated as an IHE On-Demand Document.

OperationOutcome Extensions

OperationOutcome – OrderSplitting

Provides information about how laboratory tests were grouped during order splitting.

Example value:

009001|488162;500199

Organization / Location Extensions

Provider Compendium

References the set of tests that can be ordered from the specified provider.

Questionnaire Extensions

Questionnaire – RequiredWhenSpecimenCollected

Indicates that an AOE answer is required when a specimen has been collected.

Questionnaire – Constraints

Defines additional constraints related to the AOE question.

ReferralRequest Extensions

ReferralRequest – Recipient

Defines the practitioner and organization that should receive the referral.

Child Elements

FieldTypeCardDescription
agentReference(Practitioner)1..1Practitioner receiving the referral
locationReference(Location)0..1Practitioner location
onBehalfOfReference(Organization)1..1Organization practitioner represents

Example:

{
  "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

Represents the response message associated with an incoming referral.

Example:

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

ReferralRequest – DeliveryOptions

Specifies how the referral should be delivered to the recipient.

Child Elements

FieldTypeCardDescription
methodContactPoint0..*Delivery method

Example:

{
  "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"
      }
    }
  ]
}

Subscription Extensions

Subscription – Channel Secret

Provides an HMAC signing secret used to validate subscription notifications.

Child Elements

FieldTypeDescription
valueString32-character hex signing secret
idStringSecret identifier
endDateTimeExpiration time

Example:

{
  "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"
    }
  ]
}

PractitionerRole Extensions

PractitionerRole – Read-only

Indicates that the practitioner role has read-only access.

Example:

{
  "extension": [
    {
      "url": "https://www.healthgorilla.com/fhir/StructureDefinition/practitioner-role-readonly",
      "valueBoolean": true
    }
  ]
}

Condition Extensions

Condition – Encounter

Provides a reference to the encounter associated with the condition.

Updated 3 months ago

Updated 3 months ago