com.github.vitalsoftware.scalaredox
models
Advance directive documents that the healthcare organization has on file for the patient.
describes any medication allergies, food allergies, or reactions to other substances (such as latex, iodine, tape adhesives).
describes any medication allergies, food allergies, or reactions to other substances (such as latex, iodine, tape adhesives). At a minimum, it should list currently active and relevant historical allergies and adverse reactions.
A code for the type of allergy intolerance this is (food, drug, etc.). Allergy/Adverse Event Type Value Set
The substance that the causes the alergy/intolerance. Brand names and generics will be coded in RxNorm. Drug classes use NDF-RT, and foods use UNII
A code for the reaction caused by the allergy (dissiness, hives ,etc.). SNOMED CT
A code for the severity of the reaction (moderate, severe, etc.). SNOMED CT
The current status of the Allergy (active, historic, etc.). SNOMED CT (Active, Inactive, Resolved)
When the allergy was first noted. ISO 8601 Format
When the allergy was no longer a problem (if applicable). ISO 8601 Format
Free text comment about the allergy.
Location of the patient.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Location of provider or care given.
Location of provider or care given.
Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Facility. Example: Community Hospital
Department
Result from laboratories, imaging procedures, and other procedures.
Result from laboratories, imaging procedures, and other procedures.
The test performed and resulted. LOINC for Lab - SNOMED CT otherwise
The status of the test (In Progress, Final)
A list of corresponding observations for the test (result components)
List of supplementary clinical information associated with the order.
List of supplementary clinical information associated with the order. Often these are answers to Ask at Order Entry (AOE) questions.
Code for the information element
Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.
Description of the information element. For AOEs, this is typically the text of the AOE question
Value of the information element. For AOEs, this is typically the full answer
Units of the value. If the Value is a time range, this may be "WK"
Abbreviation of the value of the information element. Typically only present for text answer AOEs
Notes related to the clinical info
A Clinical Summary represents a snapshot of the patient's chart at a moment in time.
A Clinical Summary represents a snapshot of the patient's chart at a moment in time. It is structured in sections, each focusing on a different aspect of the patient's chart, such as allergies, immunizations, and medications. The full list of sections is at the left.
You can obtain a Clinical Summary from an EHR via Query. You can send a Clinical Summary to an EHR via Push.
Code reference (like a foreign key into a SNOMED, ICD-9/10, or other data set)
Personal relationship to the patient. e.x. Father, Spouse
E.g. "Emergency contact"
About a patient.
About a patient.
Required
Required
Required. Patient's date of birth. In ISO 8601 format
Required
Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). http://www.mathguide.de/info/tools/languagecode.html
Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US').
List at http://phinvads.cdc.gov/vads/ViewValueSet.action?id=66D34BBC-617F-DD11-B38D-00188B398520
List at https://phinvads.cdc.gov/vads/ViewValueSet.action?id=35D34BBC-617F-DD11-B38D-00188B398520
List at https://www.hl7.org/fhir/v3/ReligiousAffiliation/index.html
List at http://www.hl7.org/FHIR/v2/0002/index.html
The diagnosis as free text
When the diagnosis was recorded. ISO 8601 Format
Absent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true
An array of formal designations for this diagnosis
Your application's ID for the document
Provider responsible for this document
If the document is tied to a visit
The language of the document.
The title of the document.
The creation/publishing date/time of the document.
The type of document (CCD, progress note, etc.)
The size of the dose
The units of the dose
[UCUM Units of Measure](http://unitsofmeasure.org/ucum.html)
Guarantor's Employer
A code describing the type of encounter (office visit, hospital, etc). CPT-4
When the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present. ISO 8601 Format
When the encounter was completed, if available. ISO 8601 Format
Providers seen
The type of location where the patient was seen (Clinic, Urgent Care, Hostpital).
List of Diagnoses associated with the visit. SNOMED CT
The reason for the visit (usually this is what the patient reports). SNOMED CT
This section lists the patient's past encounters at the health system and associated diagnoses.
This section lists the patient's past encounters at the health system and associated diagnoses.
Free text form of the encounters summary
Patient encounters
Gender of the relative
Date of Birth of the relative. In YYYY-MM-DD format
This section contains entries for a patient's relatives and their health problems.
This section contains entries for a patient's relatives and their health problems.
Free text form of the family history summary
An array of family history observations
Health problem.
Health problem.
A code for the particular problem experienced by the relative. SNOMED CT
The general class of the problem. (disease, problem, etc.).
https://phinvads.cdc.gov/vads/ViewValueSet.action?id=71FDBFB5-A277-DE11-9B52-0015173D1785
The Flowsheet data model allows integration of discrete clinical data.
The Flowsheet data model allows integration of discrete clinical data. Flowsheets data includes patient assessment information on both the inpatient and outpatient side. It also includes vitals and any discrete nursing documentation.
Person ultimately responsible for the bill of the appointment
Person ultimately responsible for the bill of the appointment
Relation to the patient. E.x. self, parent
Type of guarantor. E.g. institution, individual
Guarantor's employer
Information about the patient and where the summary came from
Information about the patient and where the summary came from
An object containing metadata about the document being pushed to the destination.
Patient
Patient identifier
Patient identifier
The actual identifier for the patient.
An ID type associated with identifier (Medical Record Number, etc.)
Immunization given.
Immunization given.
When the immunization was given. ISO 8601 Format
The way in which the immunization was delivered (Intramuscular, Oral, etc.). [Medication Route FDA Value Set](http://www.fda.gov/ForIndustry/DataStandards/StructuredProductLabeling%20/ucm162034.htm)
The vaccination that was given.
Dosage
Immunization product (i.e.
Immunization product (i.e. vaccine)
The vaccination that was given.
Name of organization that manufacture the immunization. Free text
The lot number of the vaccine
[CVX code system](http://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.12.292)
This section lists the patient's current immunization status and pertinent immunization history.
List of insurance coverages for the patient
List of insurance coverages for the patient
Insurance plan
Insurance company
Insurance policy group number
Insurance policy group name
Effect date of this insurance policy. In YYYY-MM-DD format
Expiration date of this insurance policy. In YYYY-MM-DD format
Insurance policy number
Type of insurance agreement. One of the following: "Standard", "Unified", "Maternity"
Type of insurance agreement. One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
Individual who has the agreement with the insurance company for the related policy
ID of insurance company (payor)
ID type of insurance company (payor)
Name of insurance company (payor)
Insurance company's address
Insurance companys phone number. In E. 164 Format (i.e. +16085551234)
Identifier of insurance plan
ID type of insurance plan
Name of insurance plan
Individual who has the agreement with the insurance company for the related policy
Location of provider or care given.
Location of provider or care given.
https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.259 Note: Seems duplicative of CareLocation, but described using the generic 'Code' object
File type of the document. E.g. PDF, JPG
Name of the file
(Base64) @see [Redox BLOB URI](http://docs.redoxengine.com/developer-documentation/sending-files-through-redox)
Type of Document. This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
Unique identifier for this document. This ID is required in order to update the document
ID of the Provider responsible for the document
The authenticated status of the document. True or False. If True, Media.Authenticator must be filled out.
The provider who authenticated the document
Whether the document is available. Either: Available or Unavailable
List of providers that should be notified when this document posts to the patient's chart
Only Visit.VisitNumber A VisitNumber is highly recommended so that the document can be associated with a specific visit
Piece of medical equipment.
Piece of medical equipment.
The current status of the equipment (active, completed, etc.)
When the equipment was first put into use. ISO 8601 Format
The number of products used
A code representing the actual product. SNOMED CT
This section lists any medical equipment that the patient uses or has been prescribed.
This section lists any medical equipment that the patient uses or has been prescribed.
Free text form of the medical equipment summary
A list of medical equipment that the patient uses (cane, pacemakers, etc.)
Created by apatzer on 3/17/17.
Medication to be given.
Whether the medication is a prescription. For a prescription: true. For a patient reported med, or a med administered by a provider: false
Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
This section contains the patient's past, current, and future medications.
This section contains the patient's past, current, and future medications.
Free text form of the medications summary
Patient medications: past, current, and future
Request/response header meta-data
Request/response header meta-data
Data model. E.g. Scheduling, Results
Type of event. E.g. New, Update
DateTime of the event. ISO 8601 Format
Flag as a test message
Where the message originated. Included in messages from Redox
List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox
Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox
Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox
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.
Indicates that a limit was reached, and not all data was returned. If true, the sender may want to restrict the parameters of the request in order to match fewer results.
The ID of the discrete note component. A report ID, or documentation field ID
The name of the discrete note component. e.g. 'Severity'
The text of the note component. Plain text or RTF
Additional comments for the discrete note field
Requires only VisitNumber + VisitDateTime
ID of the order assigned by the placing system
Name of the order assigned by the placing system
Coded Observation of a patient.
Coded Observation of a patient.
Data type of the value. One of the following: "Numeric", "String", "Date", "Time", "DateTime", "Coded Entry", "Encapsulated Data". Derived from HL7 Table 0125.
The units of the measurement. [UCUM Units of Measure](http://unitsofmeasure.org/ucum.html)
Where (on or in the body) the observation is made. (e.g. "Entire hand (body structure)"). SNOMED CT
A flag indicating whether or not the observed value is normal, high, or low. [Supported Values](https://www.hl7.org/fhir/v3/ObservationInterpretation/index.html)
Order messages communicate details of diagnostic tests such as labs, radiology imaging, etc.
Order messages communicate details of diagnostic tests such as labs, radiology imaging, etc.
ID of the order assigned by the placing system
DateTime the order was placed
DateTime the specimen was collected
Source of the specimen.
Procedure that was ordered
Provider making the order
Facility this order was placed in
Priority of the order. One of the following: "Stat", "ASAP", "Routine", "Preoperative", "Timing Critical".
Date when the order becomes invalid. In YYYY-MM-DD format
Clinically relevant comments regarding the order
Order-level notes
List of diagnoses associated with this order
List of supplementary clinical information associated with the order. Often these are answers to Ask at Order Entry (AOE) questions.
The "Producer" is typically the Lab which did the resulting.
A National Provider Identifier or NPI is a unique 10-digit identification number issued to health care providers in the United States
Results from an Order
Results from an Order
ID of the order assigned by the placing system
ID assigned by the application fulfilling the order
DateTime at which the order status was updated.
DateTime the specimen was collected
Date and time the results were composed into a report and released.
Order-level notes
Current overall status of the order. One of the following: "Final", "Preliminary", "In Process", "Corrected", "Canceled".
Procedure that was ordered
Provider making the order
Current status of the order. The default value is "Resulted".
Specificity of the response requested from the receiving system. One of the following: "Acknowledgement", "Exceptions", "Replacements", "Associated Segments", "Confirmations" . This list is in increasing specificity, and the value selected will incorpate all previous options. Derived from HL7 Table 0121. The default value is "Associated Segments".
Priority of the order. One of the following: "Stat", "ASAP", "Routine", "Preoperative", "Timing Critical".
List of result components and their values
Facility this order was placed in
Patient
Meta.DataModel: "PatientAdmin", Meta.EventType: {Arrival, Cancel, Discharge, NewPatient, PatientUpdate, PatientMerge, PreAdmit, Registration, Transfer, VisitMerge, VisitUpdate}
Message header
List of IDs and IDTypes for the patient
Used for both query (without the 'PotentialMatches') and holding the response to a patient search query.
Used for both query (without the 'PotentialMatches') and holding the response to a patient search query.
Meta.DataModel: "PatientSearch", Meta.EventType: {Query, Response}
Future lab tests or other diagnostic procedure.
These are procedures that alter the state of the body, such as an appendectomy or hip replacement. SNOMED CT
The encounter type that is planned. SNOMED CT
Medications planned.
Future supplies that a patient may be given, including implants. SNOMED CT
These are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient. SNOMED CT
PlanOfCareMessage
This section contains future appointments, medications, orders, procedures, and services that a patient may be scheduled for or is waiting to be scheduled for.
When the pregnancy started. ISO 8601 Format
When the pregnancy ended. ISO 8601 Format
Estimate delivery date if pregnancy is still active.
When the problem was noticed. ISO 8601 Format
When the problem stopped (if it is not current). ISO 8601 Format
The code for the problem. . SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009)
What type of problem this is (complaint, diagnosis, symptom, etc.) HealthStatus The effect of the problem on the patient (chronically ill, in remission, etc.). SNOMED-CT
The current state of the problem (active, inactive, resolved). HITSPProblemStatus
This section contains the patient's past and current relevant medical problems.
This section contains the patient's past and current relevant medical problems.
Free text form of the problems summary
An array of all of patient relevant problems, current and historical.
These are procedures that are more observational in nature, such as an EEG or EKG.
The procedure that was performed. SNOMED CT
These are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient.
This section documents three types of things: diagnostic procedures, procedures that change the body, and services performed by clinical staff.
This section documents three types of things: diagnostic procedures, procedures that change the body, and services performed by clinical staff.
Free text form of the procedures summary
A general grouper for all things that CDA considers procedures.
Provider responsible for a Document
Provider responsible for a Document
ID of the Provider responsible for the document. This ID is required for Inpatient Visits
ID type of the ID for the Provider responsible for the document
First name of the Provider responsible for the document
Last name of the Provider responsible for the document
The type of provider for this referral. One of the following: "Referring Provider", "Referred To Provider", "Other", "Patient PCP"
List of credentials for the Provider responsible for the document. e.g. MD, PhD
Provider's address
Reference range for the result.
Reference range for the result. Numeric result values will use the low and high properties. Non-numeric result values will put the normal value in the text property.
Lower bound for a normal result
Upper bound for a normal result
The normal value for non-numeric results
Relation gender
Date of Birth of the relative. In YYYY-MM-DD format
Results messages communicate results of diagnostic tests such as labs, radiology imaging, etc.
Results messages communicate results of diagnostic tests such as labs, radiology imaging, etc.
Value of the result component. If ValueType is "Encapsulated Data" this field includes the Redox BLOB URI
Data type for the result value. One of the following: "Numeric", "String", "Date", "Time", "DateTime", "Coded Entry", "Encapsulated Data". Derived from [HL7 Table 0125](https://phinvads.cdc.gov/vads/ViewValueSet.action?id=86E09BA6-0767-E011-8B0C-00188B39829B).
If ValueType is "Encapsulated Data", this field includes the type of file. E.g. PDF, JPG
Units of the result
Notes about the result component/observation
Indication of whether the result was abnormal. One of the following: "Normal", "Low", "Very Low", "High", "Very High", "Abnormal", "Very Abnormal". Abnormal flags starting with "Very" indicate a panic level. The "High" and "Low" flags should be used with Numeric result values while "Abnormal" should be used with non-numeric values.
Current status of the result. One of the following: "Final", "Incomplete", "Preliminary", "Corrected", "Preliminary"
The "Producer" is typically the Lab which did the resulting.
The provider who produced this result
Reference range for the result. Numeric result values will use the low and high properties. Non-numeric result values will put the normal value in the text property.
Method used to obtain the observation. This field is used when an observation may be obtained by different methods and the sending system wishes to indicate which method was used.
Person who produced the order result.
Results messages communicate results of diagnostic tests such as labs, radiology imaging, etc.
This section contains information such as tobacco use, pregnancies, and generic social behavior observations.
This section contains information such as tobacco use, pregnancies, and generic social behavior observations.
Free text form of the social history summary
Generic observations about the patient's social hisotry that don't fall into the smoking or pregnancy categories.
A code for the observation (exercise, alcohol intake, etc.) . SNOMED CT
The coded observed value for the code
The observed value for the code
Source of the specimen. [Allowed values](http://phinvads.cdc.gov/vads/ViewValueSet.action?id=C9271C18-7B67-DE11-9B52-0015173D1785)
Body site from which the specimen was collected. [Allowed values](http://www.hl7.org/FHIR/v2/0163/index.html)
ID of the collected specimen
The state of the plan (intent, confirmed, etc).
The state of the plan (intent, confirmed, etc). @see [Plan of care status](http://wiki.siframework.org/CDA+-+Plan+of+Care+Activity+Entries)
Time period for medication.
Time period for medication.
How often the patient should be taking the medication.
Units for how often the patient should be taking the medication
[UCUM Units of Measure](http://unitsofmeasure.org/ucum.html)
A code indicating the status (current smoker, never smoker, snuff user, etc.). Contains all values descending from the SNOMED CT® 365980008 tobacco use and exposure - finding hierarchy
Start date of status
Date status ended. If this is null, the status is current.
TODO: Running into Function22 and Tuple22 limits here...
TODO: Running into Function22 and Tuple22 limits here... https://stackoverflow.com/questions/20258417/how-to-get-around-the-scala-case-class-limit-of-22-fields Case class is fine, but Scala macro for Json formatting is not. Temporary solution is to comment a few items out... Better solution is use play-json-extensions to support OFormat for 22+ field case classes See pull request at https://github.com/xdotai/play-json-extensions/pull/34
Free text form of the allergies summary
A code for the type of allergy intolerance this is (food, drug, etc.). [Allergy/Adverse Event Type Value Set](http://phinvads.cdc.gov/vads/ViewValueSet.action?id=7AFDBFB5-A277-DE11-9B52-0015173D1785)
Free text of the clinician's conclusions and working assumptions that will guide treatment of the patient
An array of diagnoses
Free text chief complaint with any documented exposition
A code describing the type of encounter (office visit, hospital, etc). CPT-4
Free text describing the history related to the reason for the encounter
Free text form of the medications summary
Array of medications
Free text regarding the physical exam, observations by clinician
Free text form of the plan of care summary
Free text form of the problems summary
An array of all of patient relevant problems, current and historical.
Free text describing the patient's reason for the patient's visit
Free text form of the results summary
Array of test results for the patient. This can include laboratory results, imaging results, and procedure Results[].
Free text about symptoms and wellbeing of the patient
Free text description of the patient's condition as reported by the patient and documented by the clinician
Free text form of the vital signs summary
An array of groups of vital signs. Each element represents one time period in which vitals were recorded.
Information about the visit associate with models.Order and/or models.Result
Information about the visit associate with models.Order and/or models.Result
Length of visit. In minutes
Patient class is used in many EHRs to determine where to put the patient. Examples: Inpatient, Outpatient, Emergency
Location of the appointment
ID of the attending provider. This ID is required for Inpatient Visits
Person ultimately responsible for the bill of the appointment
List of insurance coverages for the patient
Appointment instructions
Patient balance due for this visit. This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
This query finds and returns visit summaries for a given patient at the specified health system within the specified timeframe.
This query finds and returns visit summaries for a given patient at the specified health system within the specified timeframe. Include the fields listed in the VisitQuery section in the body of your request. The response will contain these sections: Header, Allergies, Assessment, ChiefComplaint, Encounters, HistoryOfPresentIllness, Instructions, Interventions, Medications, Objective, PhysicalExam, PlanOfCare, Problems, ReasonForReferral, ReasonForVisit, Results, ReviewOfSystems, Subjective, VitalSigns.
You must provide the patient's medical record number (MRN) as part of the query. The ID type that corresponds to the MRN varies per health system. You should work with the health system to determine which ID type to send. If you do not already have a patient's MRN on file, you can obtain it using the PatientSearch data model. For testing purposes, the Redox Health System is connected to the NIST Document Sharing Test Facility, which uses the "NIST" ID type for the MRN. The PatientSearch data model will return a NIST ID that you should use with the VisitQuery.
ID for the patient visit/encounter. Either this or a timeframe is required. If both are provided, the visit number will be used.
Beginning of the timeframe for which to request visit summaries. Either this or a visit number is required. If both are provided, the visit number will be used. ISO 8601 Format
End of the timeframe for which to request visit summaries. The maximum and default timeframe will extend 5 days from the start date. If both are provided, the visit number will be used. ISO 8601 Format
The date and time of the reading. ISO 8601 Format
The type of vital sign being read (height, weight, blood pressure, etc.). Subset of LOINC codes (HITSP Vital Sign Result Type).
This sections contains all vital sign readings for a patient recorded over time.
This sections contains all vital sign readings for a patient recorded over time.
Free text form of the vital signs summary
An array of groups of vital signs. Each element represents one time period in which vitals were recorded.
Created by apatzer on 3/17/17.
A New message is used to add a new document to the patient's chart.
A New message is used to add a new document to the patient's chart.
Created by apatzer on 3/23/17.
Created by apatzer on 3/23/17.
Advance directive documents that the healthcare organization has on file for the patient.
The value of the advance directive (such as 'Do not resuscitate'). SNOMED CT
Effective start date of the advance directive. ISO 8601 Format
Effective end date of the advance directive. ISO 8601 Format
A link to a location where the document can be accessed.
A collection of people who verified the advance directive with the patient
People legally responsible for the advance directive document.