Appearance
Endpoint: /Patient/GetDataCategory
This endpoint will allow a GEHRIMED Patient ID, a date or date range, and a specific category, or set of categories, of data to be provided, returning that data for a patient with that GEHRIMED Patient ID. Some categorical data is applicable to date filtering, whereas some is not. The list of applicable categories is as follows:
- Problem List - no date range filtering
- Medication Allergies - no date range filtering
- Unique Device Identifiers for Implantables - no date range filtering
- Care Team Members - no date range filtering
- Assessment and Plan of Treatment - no date range filtering
- Goals - no date range filtering
- Health Concerns - no date range filtering
- Procedures - return all procedure records before the "end date", aka do not filter ou
- Laboratory Tests (Orders) - filter by date order was entered in the database
- Laboratory Results - returned for any lab order requested, regardless of date result
- Medications - filter by Date Started and Date Stopped (if null, include)
- Immunizations - filter by date range
- Vital Signs - returns vitals from the most recent date on which vitals where captured
Any date range for a category of data that date is not applicable to will be ignored.
When requesting categorical data, any number of categories may be requested at once, using an array of strings called "Categories".
Valid categories are as follows: (and must be requested by this verbatim name)
- Medications
- ProblemList
- MedicationAllergies
- Immunizations
- ImplantableDevices
- Procedures
- LabOrders
- Vitals
- CareTeam
- TreatmentPlan
- Goals
- HealthConcerns
Request : JSON
{
"PatientID": 154791,
"StartDate": "2011-11-09",
"EndDate": "2011-11-09",
"Categories": [
"ProblemList",
"Medications",
"MedicationAllergies",
"Immunizations",
"ImplantableDevices",
"Procedures",
"LabOrders",
"Vitals",
"CareTeam",
"TreatmentPlan",
"Goals",
"HealthConcerns"
]
}| Field | Data Type | Required | Comments |
|---|---|---|---|
| PatientID | Long | Required | GEHRIMED PatientID |
| StartDate | Date | Optional | Start date to filter data on. |
| EndDate | Date | Optional | End date to filter data on. |
| Categories | String[] | Required | Array containing at least one of the categories defined above. Response will contain data for all categories included in this list. |
Response : JSON
{
"Metadata": {
"ApiSender": "GEHRIMED",
"ApiConsumer": "gpm_internal",
"MessageDateTime": "2018-09-12T16:44:25.850Z"
},
"Data": {
"ProblemList": {
"ProblemList": [
{
"ICD10": "E66.3",
"SNOMED": 238131007,
"Status": 3,
"StatusText": "Resolved"
},
{
"ICD10": "R50.9",
"SNOMED": 386661006,
"Status": 1,
"StatusText": "Active"
},
{
"ICD10": "T86.11",
"SNOMED": 236578006,
"Status": 1,
"StatusText": "Active"
},
{
"ICD10": "E03.8",
"SNOMED": 83986005,
"Status": 1,
"StatusText": "Active"
},
{
"ICD10": "I10",
"SNOMED": 59621000,
"Status": 1,
"StatusText": "Active"
}
]
},
"Medications": {
"MedicationList": [
{
"RxNormCode": "731241",
"GenericName": "darbepoetin alfa in polysorbat",
"BrandName": "Aranesp (in polysorbate)",
"Strength": "500 mcg/mL",
"Dose": "1",
"DoseUnit": "syringe",
"Route": "subcutaneously",
"Frequency": "once a week",
"DateStarted": "2018-08-22T04:00:00.000Z",
"Status": "Active",
"Quantity": 10,
"Refills": 0,
"SubstitutionPermitted": true,
"PatientNotes": "",
"OtherNotes": "",
"StopReason": "",
"PrescriptionID": "SB-23350062441",
"Form": "syringe",
"IsSupply": false,
"IsCompound": false,
"NDC": "55513003201",
"ProviderID": 2000020,
"Source": "DrFirst",
"DoseOther": ""
},
{
"RxNormCode": "309090",
"GenericName": "ceftriaxone",
"BrandName": "ceftriaxone",
"Strength": "10 gram",
"Dose": "1",
"DoseUnit": "unit",
"Route": "subcutaneously",
"Frequency": "twice a day",
"DateStarted": "2018-09-04T04:00:00.000Z",
"Status": "Active",
"Quantity": 20,
"Refills": 0,
"SubstitutionPermitted": true,
"PatientNotes": "",
"OtherNotes": "",
"StopReason": "",
"PrescriptionID": "SB-23350062431",
"Form": "recon soln",
"IsSupply": false,
"IsCompound": false,
"NDC": "00781321046",
"ProviderID": 2000020,
"Source": "DrFirst",
"DoseOther": ""
},
{
"RxNormCode": "209459",
"GenericName": "acetaminophen",
"BrandName": "Tylenol Extra Strength",
"Strength": "500 mg",
"Dose": "1",
"DoseUnit": "tablet",
"Route": "by mouth",
"Frequency": "as directed",
"DateStarted": "2018-09-04T04:00:00.000Z",
"Status": "Active",
"Quantity": 10,
"Refills": 0,
"SubstitutionPermitted": true,
"PatientNotes": "",
"OtherNotes": "",
"StopReason": "",
"PrescriptionID": "SB-23350062435",
"Form": "tablet",
"IsSupply": false,
"IsCompound": false,
"NDC": "50580044913",
"ProviderID": 2000020,
"Source": "DrFirst",
"DoseOther": "as needed"
},
{
"RxNormCode": "309090",
"GenericName": "ceftriaxone",
"BrandName": "ceftriaxone",
"Strength": "10 gram",
"Dose": "1",
"DoseUnit": "unit",
"Route": "subcutaneously",
"Frequency": "twice a day",
"DateStarted": "2018-08-22T04:00:00.000Z",
"Status": "Inactive",
"Quantity": 20,
"Refills": 0,
"SubstitutionPermitted": true,
"PatientNotes": "",
"OtherNotes": "",
"StopReason": "",
"DateStopped": "2018-09-01T04:00:00.000Z",
"PrescriptionID": "SB-23350062431",
"Form": "recon soln",
"IsSupply": false,
"IsCompound": false,
"NDC": "00781321046",
"ProviderID": 2000020,
"Source": "DrFirst",
"DoseOther": ""
},
{
"RxNormCode": "209459",
"GenericName": "acetaminophen",
"BrandName": "Tylenol Extra Strength",
"Strength": "500 mg",
"Dose": "1",
"DoseUnit": "tablet",
"Route": "by mouth",
"Frequency": "as directed",
"DateStarted": "2018-08-22T04:00:00.000Z",
"Status": "Inactive",
"Quantity": 10,
"Refills": 0,
"SubstitutionPermitted": true,
"PatientNotes": "",
"OtherNotes": "",
"StopReason": "",
"DateStopped": "2018-09-01T04:00:00.000Z",
"PrescriptionID": "SB-23350062435",
"Form": "tablet",
"IsSupply": false,
"IsCompound": false,
"NDC": "50580044913",
"ProviderID": 2000020,
"Source": "DrFirst",
"DoseOther": "as needed"
}
]
},
"MedicationAllergies": {
"MedicationAllergyList": [
{
"Allergy": "ampicillin",
"Reaction": "Hives: 247472004",
"AdverseEventDate": "1980-05-10T04:00:00.000Z",
"Status": "Active",
"Source": "gEHRiMed",
"LastModifiedDate": "2018-08-27T04:00:00.000Z",
"DataSource": "DrFirst",
"Severity": "Moderate",
"NDC": "",
"ExternalAllergyID": "2375041000"
},
{
"Allergy": "penicillin G",
"Reaction": "Hives: 247472004",
"AdverseEventDate": "1980-05-10T04:00:00.000Z",
"Status": "Active",
"Source": "gEHRiMed",
"LastModifiedDate": "2018-08-27T04:00:00.000Z",
"DataSource": "DrFirst",
"Severity": "Moderate",
"NDC": "",
"ExternalAllergyID": "2375040997"
}
]
},
"Immunizations": {
"ImmunizationList": [
{
"VaccineName": "DTaP, 5 pertussis antigens",
"DateOfService": "2012-01-04T05:00:00.000Z",
"VaccineLotNum": "2",
"ManufacturerName": "Immuno-US",
"ManufacturerCode": "IUS",
"Notes": "",
"ImmunizationDate": "2012-01-04T05:00:00.000Z",
"CVX": "106",
"ProcessStatus": 2,
"ReadOnly": false,
"Status": "Completed"
},
{
"VaccineName": "influenza, intradermal, quadrivalent, preservative",
"DateOfService": "2015-06-22T04:00:00.000Z",
"ManufacturerName": "Immuno-US",
"ManufacturerCode": "IUS",
"Notes": "Immunization was not given - Patient rejected immunization",
"ImmunizationDate": "2015-06-22T04:00:00.000Z",
"CVX": "166",
"ProcessStatus": 2,
"ReadOnly": false,
"Status": "Cancelled"
}
]
},
"ImplantableDevices": {
"ImplantableDeviceList": [
{
"UDI": "(01)10884521062856(11)141231(17)150707(10)A213B1(21)1234",
"Description": "Polyester suture",
"BrandName": "Ti-Cron",
"VersionModelNumber": "88863380-82",
"CompanyName": "Covidien LP",
"MRISafetyStatus": "Labeling does not contain MRI Safety Information",
"LabeledContainsNRL": "false",
"LotNumber": "A213B1",
"SerialNumber": "1234",
"ExpirationDate": "2015-07-07",
"ManufacturedDate": "2014-12-31",
"DeviceIdentifier": "10884521062856",
"IsActive": true
},
{
"UDI": "+B066000325011NS1/$$420020216LOT123456789012345/SXYZ456789012345678/16D20130202C1",
"Description": "Cardiopulmonary bypass system filter, arterial blood line",
"BrandName": "CAP, NON VENTED FEMALE: BLUE NON-STERILE",
"VersionModelNumber": "000325-011NS",
"CompanyName": "NOVOSCI CORP.",
"MRISafetyStatus": "Labeling does not contain MRI Safety Information",
"LabeledContainsNRL": "false",
"LotNumber": "LOT123456789012345",
"SerialNumber": "XYZ456789012345678",
"ExpirationDate": "2020-02-02",
"ManufacturedDate": "2013-02-02",
"DeviceIdentifier": "B066000325011NS1",
"IsActive": true
},
{
"UDI": "=/W4146EB0010T0475=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123",
"Description": "Cadaveric-donor/synthetic mineral bone graft",
"BrandName": "Trabexus® EB",
"VersionModelNumber": "10 cc",
"CompanyName": "Vivorte, Inc",
"MRISafetyStatus": "Labeling does not contain MRI Safety Information",
"LabeledContainsNRL": "false",
"LotNumber": "000000000000XYZ123",
"SerialNumber": "000025",
"ExpirationDate": "2014-02-01",
"ManufacturedDate": "2013-02-01",
"DeviceIdentifier": "W4146EB0010T0475",
"DonationID": "A99971312345600",
"IsActive": true
}
]
},
"Procedures": {
"ProcedureList": [
{
"DateOfService": "2018-09-10T04:00:00.000Z",
"ProcedureCode": "108220007",
"Description": "Evaluation AND/OR management - new patient (procedure)",
"Comment": "Patient comment",
"Status": 1,
"LastModifiedBy": 1131
},
{
"DateOfService": "2018-09-10T04:00:00.000Z",
"ProcedureCode": "108224003",
"Description": "Preventive patient evaluation (procedure)",
"Comment": "Patient evaluation",
"Status": 1,
"LastModifiedBy": 1131
}
]
},
"LabOrders": {
"LabOrderList": [
{
"RequestedDate": "2015-06-22T04:00:00.000Z",
"ScheduledDate": "2015-06-22T04:00:00.000Z",
"ServiceCode": "24357-6",
"ServiceCodeText": "Urinalysis macro (dipstick) panel - Urine",
"TransactionDate": "2015-06-22T04:00:00.000Z",
"RequestedBy": 2000020,
"StatusCode": 1,
"AddedDate": "2018-08-23T04:00:00.000Z",
"LabResult": [
{
"ObservationCode": "5778-6",
"ObservationCodeText": "Color of Urine",
"ObservationValue": "YELLOW",
"ObservationReferenceRange": "YELLOW",
"ResultStatus": "F",
"PerformingOrganizationName": "Value Labs",
"PerformingOrganizationAddress": "2474 Rocky place",
"PerformingOrganizationCity": "Beaverton",
"PerformingOrganizationState": "OR",
"PerformingOrganizationZip": "97006",
"StatusCode": 0,
"AddedDate": "2018-08-23T04:00:00.000Z"
},
{
"ObservationCode": "5767-9",
"ObservationCodeText": "Appearance of Urine",
"ObservationValue": "CLEAR",
"ObservationReferenceRange": "CLEAR",
"ResultStatus": "F",
"PerformingOrganizationName": "Value Labs",
"PerformingOrganizationAddress": "2474 Rocky place",
"PerformingOrganizationCity": "Beaverton",
"PerformingOrganizationState": "OR",
"PerformingOrganizationZip": "97006",
"StatusCode": 0,
"AddedDate": "2018-08-23T04:00:00.000Z"
},
{
"ObservationCode": "5811-5",
"ObservationCodeText": "Specific gravity of Urine by Test strip",
"ObservationValue": "1.015",
"ObservationReferenceRange": "1.005-1.030",
"ResultStatus": "F",
"PerformingOrganizationName": "Value Labs",
"PerformingOrganizationAddress": "2474 Rocky place",
"PerformingOrganizationCity": "BEAVERTON",
"PerformingOrganizationState": "OR",
"PerformingOrganizationZip": "97006",
"StatusCode": 0,
"AddedDate": "2018-08-23T04:00:00.000Z"
},
{
"ObservationCode": "5803-2",
"ObservationCodeText": "pH of Urine by Test strip",
"ObservationValue": "5.0",
"ObservationUnitsText": "pH",
"ObservationReferenceRange": "5.0-8.0",
"ResultStatus": "F",
"PerformingOrganizationName": "Value Labs",
"PerformingOrganizationAddress": "2474 Rocky place",
"PerformingOrganizationCity": "BEAVERTON",
"PerformingOrganizationState": "OR",
"PerformingOrganizationZip": "97006",
"StatusCode": 0,
"AddedDate": "2018-08-23T04:00:00.000Z"
},
{
"ObservationCode": "5792-7",
"ObservationCodeText": "Glucose [Mass/volume] in urine by test strip",
"ObservationValue": "50",
"ObservationUnitsText": "mg/dL",
"ObservationReferenceRange": "Neg",
"ResultStatus": "F",
"PerformingOrganizationName": "Value Labs",
"PerformingOrganizationAddress": "2474 Rocky place",
"PerformingOrganizationCity": "BEAVERTON",
"PerformingOrganizationState": "OR",
"PerformingOrganizationZip": "97006",
"StatusCode": 0,
"AddedDate": "2018-08-23T04:00:00.000Z"
},
{
"ObservationCode": "5797-6",
"ObservationCodeText": "Ketones [Mass/Volume] in urine by test strip",
"ObservationValue": "NEGATIVE",
"ObservationReferenceRange": "Negative",
"ResultStatus": "F",
"PerformingOrganizationName": "Value Labs",
"PerformingOrganizationAddress": "2474 Rocky place",
"PerformingOrganizationCity": "BEAVERTON",
"PerformingOrganizationState": "OR",
"PerformingOrganizationZip": "97006",
"StatusCode": 0,
"AddedDate": "2018-08-23T04:00:00.000Z"
},
{
"ObservationCode": "5804-0",
"ObservationCodeText": "Protein[Mass/Volume] in urine by test strip",
"ObservationValue": "100",
"ObservationUnitsText": "mg/dL",
"ObservationReferenceRange": "Negative",
"ResultStatus": "F",
"PerformingOrganizationName": "Value Labs",
"PerformingOrganizationAddress": "2474 Rocky place",
"PerformingOrganizationCity": "BEAVERTON",
"PerformingOrganizationState": "OR",
"PerformingOrganizationZip": "97006",
"StatusCode": 0,
"AddedDate": "2018-08-23T04:00:00.000Z"
}
]
},
{
"RequestedDate": "2015-06-29T04:00:00.000Z",
"ServiceCode": "24357-6",
"ServiceCodeText": "Urinalysis macro (dipstick) panel - Urine",
"RequestedBy": 2000020,
"StatusCode": 5,
"AddedDate": "2018-08-24T04:00:00.000Z"
}
]
},
"Vitals": {
"VitalsList": [
{
"Name": "Weight",
"Data": "123",
"AdditionalData": "pounds",
"DateEntered": "2011-11-09T05:00:00.000Z"
},
{
"Name": "Height",
"Data": "70",
"AdditionalData": "inches",
"DateEntered": "2011-11-09T05:00:00.000Z"
},
{
"Name": "Pulse",
"Data": "55",
"AdditionalData": "BPM",
"DateEntered": "2011-11-09T05:00:00.000Z"
},
{
"Name": "Blood Pressure",
"Data": "55/55",
"AdditionalData": "",
"DateEntered": "2011-11-09T05:00:00.000Z"
},
{
"Name": "O2 Saturation",
"Data": "55",
"AdditionalData": "Room Air",
"DateEntered": "2011-11-09T05:00:00.000Z"
},
{
"Name": "Temperature",
"Data": "55",
"AdditionalData": "Fahrenheit",
"DateEntered": "2011-11-09T05:00:00.000Z"
},
{
"Name": "Respiratory Rate",
"Data": "55",
"AdditionalData": "Breaths per minute",
"DateEntered": "2011-11-09T05:00:00.000Z"
},
{
"Name": "BMI",
"Data": "17.6",
"AdditionalData": "",
"DateEntered": "2011-11-09T05:00:00.000Z"
}
]
},
"CareTeam": {
"HistoryType": "CCDA Care Team",
"History": "Lisa Tommy - SN"
},
"TreatmentPlan": {
"HistoryType": "CCDA Care Plan",
"History": "Treatment plan notes include : item A, item B, recommendation C, order D.<div>Follow up in X months.</div>"
},
"Assessment": {
"HistoryType": "CCDA Assessment Plan",
"History": "The patient was found to have fever and Dr is suspecting Anemia based on the patient history."
},
"Goals": {
"HistoryType": "CCDA Goals",
"History": "Reduce body weight by 12 lbs before follow up.<div>Reduce cholesterol intake.</div>"
},
"HealthConcerns": {
"HistoryType": "CCDA Health Concerns",
"History": "Higher cholesterol than should have, given prescribed diet.<div>Slightly overweight, could be contributing.</div>"
}
}
}MetaData
| Field | Data Type | Comments |
|---|---|---|
| Metadata | Metadata | See Response Metadata section. |
| Data | Data | Data wrapper that contains category wrappers. |
ProblemList
| Field | Data Type | Comments |
|---|---|---|
| ProblemList | ProblemList | Problem list category wrapper. |
| ProblemList.ProblemList | Array | List of problem list objects. |
| ProblemList.ProblemList.ICD10 | String | ICD10 code. |
| ProblemList.ProblemList.SNOMED | Int | SNOMED code. |
| ProblemList.ProblemList.Status | Int | Status code |
| ProblemList.ProblemList.StatusText | String | Status description. |
Medications
| Field | Data Type | Comments |
|---|---|---|
| Medications | Medications | Medication category wrapper. |
| Medications.MedicationList | Array | List of Medication objects. |
| Medications.MedicationList.RxNormCode | String | Rx Norm database code. |
| Medications.MedicationList.Product | String | Product name. |
| Medications.MedicationList.GenericName | String | Generic name for product. |
| Medications.MedicationList.BrandName | String | Brand name. |
| Medications.MedicationList.Strength | String | Strength of medication. |
| Medications.MedicationList.Dose | String | Value for how much a dose of medication is. |
| Medications.MedicationList.DoseUnit | String | Units dosage is measured in. |
| Medications.MedicationList.Route | String | The route by which the medication should be taken. |
| Medications.MedicationList.Frequency | String | The frequency at which the medication may be taken. |
| Medications.MedicationList.DateStarted | DateTime | The date and time the medication was prescribed. |
| Medications.MedicationList.Status | String | Status of the medication. |
| Medications.MedicationList.Quantity | Int | The quantity of doses prescribed. |
| Medications.MedicationList.Refills | Int | The quantity of refills prescribed. |
| Medications.MedicationList.SubstitutionPermitted | Boolean | Whether or not substitutions are allowed. |
| Medications.MedicationList.PatientNotes | String | Notes for patient's subscription. |
| Medications.MedicationList.OtherNotes | String | General notes for subscription. |
| Medications.MedicationList.StopReason | String | Reason medication was stopped. |
| Medications.MedicationList.DateStopped | DateTime | Date and time medication was stopped. |
| Medications.MedicationList.PrescriptionID | String | Prescription ID. |
| Medications.MedicationList.Form | String | |
| Medications.MedicationList.IsSupply | Boolean | |
| Medications.MedicationList.IsCompound | Boolean | |
| Medications.MedicationList.NDC | String | NDC code. |
| Medications.MedicationList.DaysSupply | Int | Quantity of days supply for the subscription. |
| Medications.MedicationList.ProviderID | Int | Subscribing provider's ID. |
| Medications.MedicationList.Source | String | |
| Medications.MedicationList.DoseOther | String |
MedicationAllergies
| Field | Data Type | Comments |
|---|---|---|
| MedicationAllergies | MedicationAllergies | Medication allergies category wrapper. |
| MedicationAllergies.MedicationAllergyList | Array | List of MedicationAllergies objects. |
| MedicationAllergies.MedicationAllergyList.SNOMED | String | SNWOMED code for allergy. |
| MedicationAllergies.MedicationAllergyList.Allergy | String | Description of allergy. |
| MedicationAllergies.MedicationAllergyList.Reaction | String | Allergic reaction description. |
| MedicationAllergies.MedicationAllergyList.AdverseEventDate | DateTime | Date and time of recorded adverse reaction. |
| MedicationAllergies.MedicationAllergyList.ExternalID | Int | External ID for allergic reaction. |
| MedicationAllergies.MedicationAllergyList.Status | String | Status of patient allergy. |
| MedicationAllergies.MedicationAllergyList.RxNormCode | String | RX Norm database code. |
| MedicationAllergies.MedicationAllergyList.Source | String | Originating source description. |
| MedicationAllergies.MedicationAllergyList.SourceDate | String | String form of date provided by originating source. |
| MedicationAllergies.MedicationAllergyList.Author | String | |
| MedicationAllergies.MedicationAllergyList.LastModifiedDate | DateTime | Date allergy record was last modified in GEHRIMED. |
| MedicationAllergies.MedicationAllergyList.DataSource | String | |
| MedicationAllergies.MedicationAllergyList.NDFRTCode | String | NDFRT code for allergy. |
| MedicationAllergies.MedicationAllergyList.AllergyType | String | Type of allergy. |
| MedicationAllergies.MedicationAllergyList.Category | String | Category of allergy. |
| MedicationAllergies.MedicationAllergyList.Severity | String | Severity of allergy. |
| MedicationAllergies.MedicationAllergyList.Note | String | Notes about allergy. |
| MedicationAllergies.MedicationAllergyList.TTY | String | |
| MedicationAllergies.MedicationAllergyList.NDC | String | NDC code for allergy. |
| MedicationAllergies.MedicationAllergyList.ExternalAllergyID | String | External ID for allergy. |
Immunizations
| Field | Data Type | Comments |
|---|---|---|
| Immunizations | Immunizations | Immunizations category wrapper. |
| Immunizations.ImmunizationList | Array | List of Immunization objects. |
| Immunizations.ImmunizationList.VaccineName | String | Immunization vaccine name. |
| Immunizations.ImmunizationList.DateOfService | DateTime | Date and time immunization was given. |
| Immunizations.ImmunizationList.AdministeredAmount | String | Amount administered for immunization. |
| Immunizations.ImmunizationList.AdministeredUnits | String | Units administered for immunization. |
| Immunizations.ImmunizationList.VaccineLotNum | String | Immunization vaccine lot number. |
| Immunizations.ImmunizationList.ManufacturerName | String | Immunization manufacturer name. |
| Immunizations.ImmunizationList.ManufacturerCode | String | Immunization manufacturer code. |
| Immunizations.ImmunizationList.Notes | String | Immunization notes. |
| Immunizations.ImmunizationList.VaccineExpirationDate | DateTime | Immunization vaccine expiration date and time. |
| Immunizations.ImmunizationList.AdministeredSite | String | Site where immunization was administered. |
| Immunizations.ImmunizationList.AdministeredRoute | String | Route by which immunization was administered. |
| Immunizations.ImmunizationList.ImmunizationDate | DateTime | Immunization date and time. |
| Immunizations.ImmunizationList.CVX | String | Immunization CVX code. |
| Immunizations.ImmunizationList.IISCode | String | Immunization IIS code. |
| Immunizations.ImmunizationList.RefusalReason | Long | Reason immunization was refused. |
| Immunizations.ImmunizationList.RegistryStatus | String | |
| Immunizations.ImmunizationList.RegistryStatusEffectiveDate | DateTime | |
| Immunizations.ImmunizationList.PublicityCode | String | |
| Immunizations.ImmunizationList.PublicityCodeEffectiveDate | DateTime | |
| Immunizations.ImmunizationList.ProtectionIndicator | String | |
| Immunizations.ImmunizationList.ProtectionIndicatorEffectiveDate | DateTime | |
| Immunizations.ImmunizationList.ProcessStatus | Int | |
| Immunizations.ImmunizationList.EnteredByName | String | Name of who entered order for immunization. |
| Immunizations.ImmunizationList.OrderedByName | String | Name of who ordered immunization. |
| Immunizations.ImmunizationList.AdministeredByName | String | Name of who administered immunization. |
| Immunizations.ImmunizationList.ReadOnly | Boolean | |
| Immunizations.ImmunizationList.Status | String |
ImplantableDevices
| Field | Data Type | Comments |
|---|---|---|
| ImplantableDevices | ImplantableDevices | Implantable devices category wrapper. |
| ImplantableDevices.ImplantableDeviceList | ImplantableDeviceList | Implantable device data records wrapper. |
| ImplantableDevices.ImplantableDeviceList.UDI | String | Unique Device Identifier for device. |
| ImplantableDevices.ImplantableDeviceList.Description | String | Device description. |
| ImplantableDevices.ImplantableDeviceList.BrandName | String | Device brand. |
| ImplantableDevices.ImplantableDeviceList.VersionModelNumber | String | Device version model number. |
| ImplantableDevices.ImplantableDeviceList.CompanyName | String | Device company name. |
| ImplantableDevices.ImplantableDeviceList.MRISafetyStatus | String | Safety status for device being present during MRI. |
| ImplantableDevices.ImplantableDeviceList.LabeledContainsNRL | String | |
| ImplantableDevices.ImplantableDeviceList.LotNumber | String | Device lot number |
| ImplantableDevices.ImplantableDeviceList.SerialNumber | String | Device serial number. |
| ImplantableDevices.ImplantableDeviceList.ExpirationDate | String | Date and time device expires. |
| ImplantableDevices.ImplantableDeviceList.ManufacturedDate | String | Date and time device was manufactured. |
| ImplantableDevices.ImplantableDeviceList.DeviceIdentifier | String | Identifier for the device. |
| ImplantableDevices.ImplantableDeviceList.DonationID | String | |
| ImplantableDevices.ImplantableDeviceList.IsActive | Boolean | Value for whether or not the device is active. |
| ImplantableDevices.ImplantableDeviceList.InactiveReason | String | Reason for the device being inactive. |
Procedures
| Field | Data Type | Comments |
|---|---|---|
| Procedures | Procedures | Procedures category wrapper. |
| Procedures.ProcedureList | ProcedureList | Procedure data wrapper. |
| Procedures.ProcedureList.DateOfService | DateTime | Date and time of procedure. |
| Procedures.ProcedureList.ProcedureCode | String | Procedure code. |
| Procedures.ProcedureList.Description | String | Description of procedure. |
| Procedures.ProcedureList.Comment | String | Procedure comments provided. |
| Procedures.ProcedureList.Status | Int | Status of procedure. |
| Procedures.ProcedureList.NegationReason | Long | Reason code for negation of procedure. |
| Procedures.ProcedureList.NegationReasonText | String | Text for negation of procedure. |
| Procedures.ProcedureList.LastModifiedBy | Int | ID of last provider who modified procedure record. |
LabOrders
| Field | Data Type | Comments |
|---|---|---|
| LabOrders | LabOrders | LabOrders category wrapper. |
| LabOrders.LabOrderList | Array | List of LabOrder objects; |
| LabOrders.LabOrderList.PlacerOrderNumber | String | |
| LabOrders.LabOrderList.FillerOrderNumber | String | |
| LabOrders.LabOrderList.RequestedDate | DateTime | Date order was requested. |
| LabOrders.LabOrderList.ObservationStartDate | DateTime | Date observation for order began. |
| LabOrders.LabOrderList.ObservationEndDate | DateTime | Date observation for order ended. |
| LabOrders.LabOrderList.SpecimenReceivedDate | DateTime | Date order specimen was received. |
| LabOrders.LabOrderList.ScheduledDate | DateTime | Date order was scheduled for. |
| LabOrders.LabOrderList.ServiceCode | String | |
| LabOrders.LabOrderList.ServiceCodeText | String | |
| LabOrders.LabOrderList.ServiceCodeSystem | String | |
| LabOrders.LabOrderList.SpecimenSource | String | Source of lab specimen for order. |
| LabOrders.LabOrderList.ResultStatus | String | Status for results of order. |
| LabOrders.LabOrderList.ResultForStudyCode | String | |
| LabOrders.LabOrderList.ResultForStudyText | String | |
| LabOrders.LabOrderList.ResultForStudyCodingSystem | String | |
| LabOrders.LabOrderList.ServiceType | String | |
| LabOrders.LabOrderList.TransactionDate | DateTime | Transaction date for order. |
| LabOrders.LabOrderList.EnteredByID | String | ID of who entered order. |
| LabOrders.LabOrderList.EnteredByFirst | String | First of who entered order. |
| LabOrders.LabOrderList.EnteredByLast | String | Last of who entered order. |
| LabOrders.LabOrderList.EnteredByDegree | String | Degree of who entered order. |
| LabOrders.LabOrderList.OrderingProviderID | String | Provider who ordered ID. |
| LabOrders.LabOrderList.OrderingProviderFirst | String | Provider who ordered first name. |
| LabOrders.LabOrderList.OrderingProviderLast | String | Provider who ordered last name. |
| LabOrders.LabOrderList.OrderingProviderDegree | String | Provider who ordered degree. |
| LabOrders.LabOrderList.OrderingProviderIDType | String | Provider who ordered ID type. |
| LabOrders.LabOrderList.OrderingProviderAssigningAuthority | String | Provider who ordered assigning authority. |
| LabOrders.LabOrderList.Source | String | |
| LabOrders.LabOrderList.Version | String | |
| LabOrders.LabOrderList.RequestedBy | Int | |
| LabOrders.LabOrderList.StatusCode | Int | |
| LabOrders.LabOrderList.EncounterID | Int | ID for encounter on which order was placed. |
| LabOrders.LabOrderList.Notes | String | Order notes. |
| LabOrders.LabOrderList.UserNotes | String | User notes for order. |
| LabOrders.LabOrderList.LabResult | Array | List of LabResult objects. |
LabResult
| Field | Data Type | Comments |
|---|---|---|
| LabResult | LabResult | LabResult category data wrapper. |
| LabResult.ValueType | String | |
| LabResult.ObservationCode | String | |
| LabResult.ObservationCodeText | String | |
| LabResult.ObservationCodeSystem | String | |
| LabResult.ObservationValue | String | Value observed for lab test. |
| LabResult.ObservationUnits | String | Units value is in. |
| LabResult.ObservationUnitsText | String | Text for value units. |
| LabResult.ObservationUnitsCodeSystem | String | Code system used for units. |
| LabResult.ObservationReferenceRange | String | |
| LabResult.AbnormalFlags | String | |
| LabResult.ResultStatus | String | Status of lab result. |
| LabResult.ObservationDate | DateTime | Date lab result was processed. |
| LabResult.ResponsibleObserverID | String | ID for party responsible for making observation. |
| LabResult.ObservationMethodCode | String | |
| LabResult.ObservationMethodCodeText | String | |
| LabResult.ObservationMethodCodeSystem | String | |
| LabResult.ProducerID | String | |
| LabResult.PerformingOrganizationID | String | |
| LabResult.PerformingOrganizationName | String | |
| LabResult.PerformingOrganizationAssigningAuthority | String | |
| LabResult.PerformingOrganizationAddress | String | |
| LabResult.PerformingOrganizationOther | String | |
| LabResult.PerformingOrganizationCity | String | |
| LabResult.PerformingOrganizationState | String | |
| LabResult.PerformingOrganizationZip | String | |
| LabResult.PerformingOrganizationState | String | |
| LabResult.StatusCode | Int | |
| LabResult.Notes | String | |
| LabResult.UserNotes | String |
Vitals
| Field | Data Type | Comments |
|---|---|---|
| Vitals | Vitals | Vitals category wrapper. |
| Vitals.VitalsList | Array | List of Vital objects. |
| Vitals.VitalsList.Name | String | The type of vital sign being represented. |
| Vitals.VitalsList.LOINC | String | LOINC code. |
| Vitals.VitalsList.Data | String | The value of the vital sign. |
| Vitals.VitalsList.AdditionalData | String | Any supplementary data that was specified in the entry. |
| Vitals.VitalsList.DateEntered | DateTime | Date and Time the vital entry was recorded. |
History Type Data
Categories include CareTeam, TreatmentPlan, Assessment, Goals, and HealthConcerns. They are represented as follows, except with the actual category listed instead of "Category".Field.
| Field | Data Type | Comments |
|---|---|---|
| Category.HistoryType | String | Describes the type of history item being represented by the data in the proceeding History field. |
| Category.History | String | The current value for the type of data described in the HistoryType field. |