Redox | FHIR.Immunization

Table of Contents

FHIR.Immunization

read
search
$write

read

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Immunization
- Meta.EventType
  String
  Reliable
  Required
  read
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
- Meta.SessionID
  String
  Possible
  Session ID to be passed through for 3rd party sessions.
  This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.
- Meta.RespondAsync
  Boolean
  Possible
  A flag for indicating that the query response should follow the Asynchronous Buld Data Request pattern
id
- id
  string
  Possible
  Required
  The id of the resource

Sample MessageDownload JSON Schema

{
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-04-25T18:45:49.188Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Immunization",
      "EventType": "read"
   },
   "id": "0a619f8d-3aa0-4e70-a4de-fff916245d1a"
}

search

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Immunization
- Meta.EventType
  String
  Reliable
  Required
  search
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
- Meta.SessionID
  String
  Possible
  Session ID to be passed through for 3rd party sessions.
  This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.
- Meta.RespondAsync
  Boolean
  Possible
  A flag for indicating that the query response should follow the Asynchronous Buld Data Request pattern
_id
- _id[]
  token
  Possible
  The internal ID (UUIDv4) of the immunization.
_count
- _count[]
  number
  Possible
  Specifies the maximum number of Immunization resources to return.
_lastUpdated
- _lastUpdated[]
  date
  Possible
  Date last updated. Server has discretion on the boundary precision.
_include
- _include[]
  special
  Possible
  Include resources referenced by the Immunization resource in the results. Value should be Immunization:parameter where the parameter is a reference-type parameter of the Immunization resource.
_revinclude
- _revinclude[]
  special
  Possible
  Include resources that reference the Immunization resource in the results. Value should be ReferencingResource:parameter where the parameter is a reference-type parameter of a resource that references the Immunization resource.
_sort
- _sort[]
  string
  Possible
  The name of a Immunization parameter used to sort multiple search results in ascending order. Prefix with - to sort in descending order.
patient
- patient[]
  reference
  Possible
  The patient to whom the immunization was administered
- patient.identifier[]
  array
  Possible
  One or more external identifiers for the patient
date
- date[]
  date
  Possible
  The date/time of the immunization (non-)administration
status
- status[]
  token
  Possible
  The status of the immunization: completed | entered-in-error | not-done

Sample MessageDownload JSON Schema

{
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-04-25T18:45:49.188Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Immunization",
      "EventType": "search"
   },
   "_id": [],
   "_count": [],
   "_lastUpdated": [],
   "_include": [],
   "_revinclude": [],
   "_sort": [],
   "patient": [],
   "date": [],
   "status": [],
   "patient.identifier": []
}

$write

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Immunization
- Meta.EventType
  String
  Reliable
  Required
  $write
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
- Meta.SessionID
  String
  Possible
  Session ID to be passed through for 3rd party sessions.
  This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.
- Meta.RespondAsync
  Boolean
  Possible
  A flag for indicating that the query response should follow the Asynchronous Buld Data Request pattern

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "id": "KevaGreenFluImmunization",
   "type": "message",
   "entry": [
      {
         "resource": {
            "resourceType": "MessageHeader",
            "id": "RedoxMessageHeaderExample",
            "source": {
               "name": "Good Health Clinics",
               "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
            },
            "eventCoding": {
               "system": "urn:redox:event-type"
            }
         }
      },
      {
         "resource": {
            "resourceType": "Immunization",
            "id": "03e815f8-9804-38e8-0444-c8af20faa4a9",
            "status": "completed",
            "vaccineCode": {
               "coding": [
                  {
                     "code": "140",
                     "system": "http://hl7.org/fhir/sid/cvx",
                     "display": "Influenza, seasonal, injectable, preservative free"
                  }
               ],
               "text": "Influenza, seasonal, injectable, preservative free"
            },
            "patient": {
               "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
            },
            "encounter": {
               "reference": "80a02b93-1ecb-f5e1-6430-1a31163f7618"
            },
            "occurrenceDateTime": "2021-01-14T13:10:39-10:00",
            "primarySource": true,
            "location": {
               "reference": "Location/a5cc27d1-5c70-39f8-a9c4-2f3696988650",
               "display": "AGELESS WELLNESS CENTER, INC"
            },
            "lotNumber": "AAJN11K"
         }
      },
      {
         "resource": {
            "resourceType": "Patient",
            "id": "81c2f5eb-f99f-40c4-b504-59483e6148d7",
            "meta": {
               "lastUpdated": "2022-12-01T21:57:23.879Z"
            },
            "identifier": [
               {
                  "value": "kyHGADnvX3xbkU4V9ayaqh",
                  "system": "urn:redox:redox-fhir-sandbox:MR"
               },
               {
                  "use": "secondary",
                  "value": "483749",
                  "system": "urn:redox:redox-fhir-sandbox:MR"
               }
            ],
            "active": true,
            "name": [
               {
                  "use": "official",
                  "given": [
                     "Keva"
                  ],
                  "family": "Green"
               }
            ],
            "telecom": [
               {
                  "use": "home",
                  "value": "+18088675302",
                  "system": "phone"
               },
               {
                  "value": "[email protected]",
                  "system": "email"
               }
            ],
            "gender": "female",
            "birthDate": "1995-08-26",
            "address": [
               {
                  "use": "home",
                  "city": "Hillsboro",
                  "line": [
                     "932 Stehr Vista"
                  ],
                  "state": "OR",
                  "country": "US",
                  "postalCode": "97123"
               }
            ],
            "link": [
               {
                  "type": "replaces",
                  "other": {
                     "reference": "Patient/69efd2ea-1256-4ae7-b4ec-5d0160427185"
                  }
               }
            ],
            "extension": [
               {
                  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                  "extension": [
                     {
                        "url": "text",
                        "valueString": "White"
                     },
                     {
                        "url": "ombCategory",
                        "valueCoding": {
                           "code": "2106-3",
                           "system": "urn:oid:2.16.840.1.113883.6.238",
                           "display": "White"
                        }
                     }
                  ]
               }
            ]
         }
      }
   ],
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2024-04-25T18:45:49.188Z",
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Immunization",
      "EventType": "$write"
   }
}

FHIR.Immunization

readlink

Fields

Meta

id

searchlink

Fields

Meta

_id

_count

_lastUpdated

_include

_revinclude

_sort

patient

date

status

$writelink

Fields

Meta

read

search

$write