Type Members

1.  case class Address(StreetAddress: Option[String] = scala.None, City: Option[String] = scala.None, State: Option[String] = scala.None, ZIP: Option[String] = scala.None, County: Option[String] = scala.None, Country: Option[String] = scala.None) extends Product with Serializable
2.  case class AdvanceDirective(Type: BasicCode = ..., Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String], StartDate: DateTime, EndDate: Option[DateTime], ExternalReference: Option[String], VerifiedBy: Seq[BasicPerson] = scala.collection.Seq.empty[Nothing], Custodians: Seq[BasicPerson] = scala.collection.Seq.empty[Nothing]) extends Code with DateRange with Product with Serializable

   Advance directive documents that the healthcare organization has on file for the patient.

   Advance directive documents that the healthcare organization has on file for the patient.

   Type

   The value of the advance directive (such as 'Do not resuscitate'). SNOMED CT

   StartDate

   Effective start date of the advance directive. ISO 8601 Format

   EndDate

   Effective end date of the advance directive. ISO 8601 Format

   ExternalReference

   A link to a location where the document can be accessed.

   VerifiedBy

   A collection of people who verified the advance directive with the patient

   Custodians

   People legally responsible for the advance directive document.

3.  case class AdvanceDirectiveMessage(AdvanceDirectivesText: Option[String] = scala.None, advanceDirectives: Seq[AdvanceDirective] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
4.  case class AllergiesMessage(AllergyText: Option[String] = scala.None, Allergies: Seq[Allergy] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

   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.

5.  case class Allergy(Type: BasicCode = ..., Substance: BasicCode = ..., Reaction: Seq[CodeWithText] = scala.collection.Seq.empty[Nothing], Severity: BasicCode = ..., Status: BasicCode = ..., StartDate: Option[DateTime] = scala.None, EndDate: Option[DateTime] = scala.None, Comment: Option[String] = scala.None) extends Product with Serializable
   Type

   A code for the type of allergy intolerance this is (food, drug, etc.). Allergy/Adverse Event Type Value Set

   Substance

   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

   Reaction

   A code for the reaction caused by the allergy (dissiness, hives ,etc.). SNOMED CT

   Severity

   A code for the severity of the reaction (moderate, severe, etc.). SNOMED CT

   Status

   The current status of the Allergy (active, historic, etc.). SNOMED CT (Active, Inactive, Resolved)

   StartDate

   When the allergy was first noted. ISO 8601 Format

   EndDate

   When the allergy was no longer a problem (if applicable). ISO 8601 Format

   Comment

   Free text comment about the allergy.

6.  case class Assessment(Diagnoses: Seq[Diagnosis] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
7.  case class BasicCode(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None) extends Code with Product with Serializable
8.  case class BasicCodeset(Code: Option[String] = scala.None, Codeset: Option[String] = scala.None, Description: Option[String] = scala.None) extends Codeset with Product with Serializable
9.  case class BasicPerson(FirstName: Option[String] = scala.None, LastName: Option[String] = scala.None, Address: Option[Address] = scala.None, PhoneNumber: Option[PhoneNumber] = scala.None, EmailAddresses: Seq[String] = scala.collection.Seq.empty[Nothing], Credentials: Option[String] = scala.None) extends WithContactDetails with Product with Serializable
10.  case class BasicVisitInfo(VisitNumber: Option[String] = scala.None, Location: Option[CareLocation] = scala.None, AccountNumber: Option[String] = scala.None) extends Product with Serializable
    Location

    Location of the patient.

    AccountNumber

    An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.

11.  case class CareLocation(Type: Option[String] = scala.None, Facility: Option[String] = scala.None, Department: Option[String] = scala.None, Room: Option[String] = scala.None, Bed: Option[String] = scala.None) extends Product with Serializable

    Location of provider or care given.

    Location of provider or care given.

    Type

    Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    Facility

    Facility. Example: Community Hospital

    Department

    Department

12.  case class ChartResult(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Status: Option[String] = scala.None, Observations: Seq[ResultObservation] = scala.collection.Seq.empty[Nothing]) extends Code with Status with Product with Serializable

    Result from laboratories, imaging procedures, and other procedures.

    Result from laboratories, imaging procedures, and other procedures.

    Code

    The test performed and resulted. LOINC for Lab - SNOMED CT otherwise

    Status

    The status of the test (In Progress, Final)

    Observations

    A list of corresponding observations for the test (result components)

13.  case class ClinicalInfo(Code: Option[String] = scala.None, Codeset: Option[String] = scala.None, Description: Option[String] = scala.None, Value: Option[String] = scala.None, Units: Option[String] = scala.None, Abbreviation: Option[String] = scala.None, Notes: Seq[String] = scala.collection.Seq.empty[Nothing]) extends Codeset with Product with Serializable

    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

    Code for the information element

    Codeset

    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

    Description of the information element. For AOEs, this is typically the text of the AOE question

    Value

    Value of the information element. For AOEs, this is typically the full answer

    Units

    Units of the value. If the Value is a time range, this may be "WK"

    Abbreviation

    Abbreviation of the value of the information element. Typically only present for text answer AOEs

    Notes

    Notes related to the clinical info

14.  case class ClinicalSummary(Meta: Meta, Header: Header, AdvanceDirectives: Seq[AdvanceDirective] = scala.collection.Seq.empty[Nothing], Allergies: Seq[Allergy] = scala.collection.Seq.empty[Nothing], Encounters: Seq[Encounter] = scala.collection.Seq.empty[Nothing], FamilyHistory: Seq[FamilyHistory] = scala.collection.Seq.empty[Nothing], Immunizations: Seq[Immunization] = scala.collection.Seq.empty[Nothing], Insurances: Seq[Insurance] = scala.collection.Seq.empty[Nothing], MedicalEquipment: Seq[MedicalEquipment] = scala.collection.Seq.empty[Nothing], Medications: Seq[MedicationTaken] = scala.collection.Seq.empty[Nothing], PlanOfCare: Option[PlanOfCare] = scala.None, Problems: Seq[Problem] = scala.collection.Seq.empty[Nothing], Procedures: Option[Procedures] = scala.None, Results: Seq[ChartResult] = scala.collection.Seq.empty[Nothing], SocialHistory: Option[SocialHistory] = scala.None, VitalSigns: Seq[VitalSigns] = scala.collection.Seq.empty[Nothing]) extends ClinicalSummaryLike with Product with Serializable

    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.

15.  trait ClinicalSummaryLike extends MetaLike with HasPatient
16.  sealed trait ClinicalSummaryObservation extends Observation with Code
17.  trait Code extends AnyRef

    Code reference (like a foreign key into a SNOMED, ICD-9/10, or other data set)

18.  case class CodeWithStatus(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Status: Option[String] = scala.None, DateTime: Option[DateTime] = scala.None) extends Code with Product with Serializable
19.  case class CodeWithText(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Text: Option[String] = scala.None) extends Code with Product with Serializable
20.  trait Codeset extends AnyRef
21.  case class CodesetWithName(Code: Option[String] = scala.None, Codeset: Option[String] = scala.None, Name: Option[String] = scala.None, Type: Option[String] = scala.None) extends Codeset with Product with Serializable
22.  case class Contact(FirstName: Option[String] = scala.None, LastName: Option[String] = scala.None, Address: Option[Address] = scala.None, PhoneNumber: Option[PhoneNumber] = scala.None, EmailAddresses: Seq[String] = scala.collection.Seq.empty[Nothing], RelationToPatient: Option[String] = scala.None, Roles: Seq[String] = scala.collection.Seq.empty[Nothing]) extends WithContactDetails with Product with Serializable
    RelationToPatient

    Personal relationship to the patient. e.x. Father, Spouse

    Roles

    E.g. "Emergency contact"

23.  trait DateRange extends AnyRef
24.  trait DateStamped extends AnyRef
25.  case class Demographics(FirstName: String, LastName: String, DOB: Option[DateTime] = scala.None, SSN: Option[String] = scala.None, Sex: SexType.Value = SexType.Unknown, Address: Option[Address] = scala.None, PhoneNumber: Option[PhoneNumber] = scala.None, EmailAddresses: Seq[String] = scala.collection.Seq.empty[Nothing], Language: Option[Language] = scala.None, Citizenship: Seq[String] = scala.collection.Seq.empty[Nothing], Race: Option[String] = scala.None, Ethnicity: Option[String] = scala.None, Religion: Option[String] = scala.None, MaritalStatus: Option[String] = scala.None) extends WithContactDetails with Product with Serializable

    About a patient.

    About a patient.

    FirstName

    Required

    LastName

    Required

    DOB

    Partially reliable. Patient's date of birth. In ISO 8601 format

    Sex

    Required

    Language

    Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). http://www.mathguide.de/info/tools/languagecode.html

    Citizenship

    Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US').

    Race

    List at http://phinvads.cdc.gov/vads/ViewValueSet.action?id=66D34BBC-617F-DD11-B38D-00188B398520

    Ethnicity

    List at https://phinvads.cdc.gov/vads/ViewValueSet.action?id=35D34BBC-617F-DD11-B38D-00188B398520

    Religion

    List at https://www.hl7.org/fhir/v3/ReligiousAffiliation/index.html

    MaritalStatus

    List at http://www.hl7.org/FHIR/v2/0002/index.html

26.  case class Diagnosis(Value: String, DateTime: DateTime, IsNegativeIndicator: Option[Boolean], Encodings: Seq[BasicCodeset] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
    Value

    The diagnosis as free text

    DateTime

    When the diagnosis was recorded. ISO 8601 Format

    IsNegativeIndicator

    Absent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true

    Encodings

    An array of formal designations for this diagnosis

27.  case class Document(ID: String, Author: Option[Provider] = scala.None, Visit: Option[VisitInfo] = scala.None, Locale: String = java.util.Locale.ROOT.toString(), Title: String, DateTime: DateTime, Type: String) extends HasVisitInfo with Product with Serializable
    ID

    Your application's ID for the document

    Author

    Provider responsible for this document

    Visit

    If the document is tied to a visit

    Locale

    The language of the document.

    Title

    The title of the document.

    DateTime

    The creation/publishing date/time of the document.

    Type

    The type of document (CCD, progress note, etc.)

28.  case class Dose(Quantity: Option[String] = scala.None, Units: Option[String] = scala.None) extends Product with Serializable
    Quantity

    The size of the dose

    Units

    The units of the dose

    See also

    [UCUM Units of Measure](http://unitsofmeasure.org/ucum.html)

29.  case class Employer(Name: Option[String] = scala.None, Address: Option[Address] = scala.None, PhoneNumber: Option[String] = scala.None) extends Product with Serializable

    Guarantor's Employer

30.  case class Encounter(Identifiers: Seq[Identifier] = scala.collection.Seq.empty[Nothing], Type: BasicCode = ..., DateTime: DateTime, EndDateTime: Option[DateTime] = scala.None, Providers: Seq[Provider] = scala.collection.Seq.empty[Nothing], Locations: Seq[Location] = scala.collection.Seq.empty[Nothing], Diagnosis: Seq[BasicCode] = scala.collection.Seq.empty[Nothing], ReasonForVisit: Seq[BasicCode] = scala.collection.Seq.empty[Nothing]) extends DateStamped with Product with Serializable
    Type

    A code describing the type of encounter (office visit, hospital, etc). CPT-4

    DateTime

    When the encounter took place, or alternatively when the encounter began if Encounters[].EndDateTime is present. ISO 8601 Format

    EndDateTime

    When the encounter was completed, if available. ISO 8601 Format

    Providers

    Providers seen

    Locations

    The type of location where the patient was seen (Clinic, Urgent Care, Hostpital).

    Diagnosis

    List of Diagnoses associated with the visit. SNOMED CT

    ReasonForVisit

    The reason for the visit (usually this is what the patient reports). SNOMED CT

31.  case class EncountersMessage(EncountersText: Option[String], Encounters: Seq[Encounter] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

    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.

    EncountersText

    Free text form of the encounters summary

    Encounters

    Patient encounters

32.  case class FamilyDemographics(Sex: SexType.Value = SexType.defaultValue, DOB: Option[LocalDate] = scala.None) extends Product with Serializable
    Sex

    Gender of the relative

    DOB

    Date of Birth of the relative. In YYYY-MM-DD format

33.  case class FamilyHistory(Relation: Relation, Problems: Seq[FamilyHistoryProblem] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
34.  case class FamilyHistoryMessage(FamilyHistoryTest: Option[String] = scala.None, FamilyHistory: Seq[FamilyHistory] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

    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.

    FamilyHistoryTest

    Free text form of the family history summary

    FamilyHistory

    An array of family history observations

35.  case class FamilyHistoryProblem(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Type: BasicCode = ..., DateTime: Option[DateTime] = scala.None, AgeAtOnset: Option[String] = scala.None, IsCauseOfDeath: Option[Boolean] = scala.None) extends Code with Product with Serializable

    Health problem.

    Health problem.

    Code

    A code for the particular problem experienced by the relative. SNOMED CT

    Type

    The general class of the problem. (disease, problem, etc.).

    See also

    https://phinvads.cdc.gov/vads/ViewValueSet.action?id=71FDBFB5-A277-DE11-9B52-0015173D1785

36.  case class FlowSheetMessage(Meta: Meta, Patient: Patient, Visit: Option[BasicVisitInfo] = scala.None, Observations: Seq[FlowsheetObservation] = scala.collection.immutable.Nil) extends MetaLike with HasPatient with Product with Serializable

    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.

37.  case class FlowsheetObservation(DateTime: DateTime, Value: Option[String] = scala.None, ValueType: Option[ValueTypes.Value] = scala.None, Units: Option[String] = scala.None, Code: Option[String] = scala.None, Codeset: Option[String] = scala.None, Description: Option[String] = scala.None, Status: Option[String] = scala.None, Notes: Seq[String] = scala.collection.Seq.empty[Nothing], Observer: Option[Provider] = scala.None, ReferenceRange: Option[ReferenceRange] = scala.None, AbnormalFlag: Option[String] = scala.None) extends Observation with Codeset with ObservationValue with Product with Serializable

    Flowsheet observation

    Flowsheet observation

    Used within Flowsheet. Has a codeset instead of system. Has an observer.

38.  case class GroupedOrdersMessage(Meta: Meta, Patient: Patient, Visit: Option[VisitInfo] = scala.None, Orders: Seq[Order] = scala.collection.Seq.empty[Nothing]) extends MetaLike with OrdersMessageLike with Product with Serializable
39.  case class Guarantor(FirstName: Option[String] = scala.None, LastName: Option[String] = scala.None, DOB: Option[LocalDate] = scala.None, Address: Option[Address] = scala.None, RelationToPatient: Option[String] = scala.None, PhoneNumber: Option[PhoneNumber] = scala.None, Type: Option[String] = scala.None, Employer: Option[Employer] = scala.None) extends Product with Serializable

    Person ultimately responsible for the bill of the appointment

    Person ultimately responsible for the bill of the appointment

    RelationToPatient

    Relation to the patient. E.x. self, parent

    Type

    Type of guarantor. E.g. institution, individual

    Employer

    Guarantor's employer

40.  trait HasPatient extends AnyRef
41.  trait HasVisitInfo extends AnyRef
42.  case class Header(Document: Document, Patient: Patient) extends HasPatient with Product with Serializable

    Information about the patient and where the summary came from

    Information about the patient and where the summary came from

    Document

    An object containing metadata about the document being pushed to the destination.

    Patient

    Patient

43.  case class Identifier(ID: String, IDType: String) extends Product with Serializable

    Patient identifier

    Patient identifier

    ID

    The actual identifier for the patient.

    IDType

    An ID type associated with identifier (Medical Record Number, etc.)

44.  case class Immunization(DateTime: DateTime, Route: Option[BasicCode] = scala.None, Product: ImmunizationProduct, Dose: Option[Dose] = scala.None) extends DateStamped with Product with Serializable

    Immunization given.

    Immunization given.

    DateTime

    When the immunization was given. ISO 8601 Format

    Route

    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)

    Product

    The vaccination that was given.

    Dose

    Dosage

45.  case class ImmunizationProduct(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Manufacturer: Option[String] = scala.None, LotNumber: Option[String] = scala.None) extends Code with Product with Serializable

    Immunization product (i.e.

    Immunization product (i.e. vaccine)

    Code

    The vaccination that was given.

    Manufacturer

    Name of organization that manufacture the immunization. Free text

    LotNumber

    The lot number of the vaccine

    See also

    [CVX code system](http://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.12.292)

46.  case class ImmunizationsMessage(ImmunizationText: Option[String] = scala.None, Immunizations: Seq[Immunization] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

    This section lists the patient's current immunization status and pertinent immunization history.

47.  case class Insurance(Plan: Option[InsurancePlan] = scala.None, Company: Option[InsuranceCompany] = scala.None, GroupNumber: Option[String] = scala.None, GroupName: Option[String] = scala.None, EffectiveDate: Option[LocalDate] = scala.None, ExpirationDate: Option[LocalDate] = scala.None, PolicyNumber: Option[String] = scala.None, AgreementType: Option[InsuranceAgreementTypes.Value] = scala.None, CoverageType: Option[InsuranceCoverageTypes.Value] = scala.None, Insured: Option[InsuredPerson] = scala.None) extends Product with Serializable

    List of insurance coverages for the patient

    List of insurance coverages for the patient

    Plan

    Insurance plan

    Company

    Insurance company

    GroupNumber

    Insurance policy group number

    GroupName

    Insurance policy group name

    EffectiveDate

    Effect date of this insurance policy. In YYYY-MM-DD format

    ExpirationDate

    Expiration date of this insurance policy. In YYYY-MM-DD format

    PolicyNumber

    Insurance policy number

    AgreementType

    Type of insurance agreement. One of the following: "Standard", "Unified", "Maternity"

    CoverageType

    Type of insurance agreement. One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.

    Insured

    Individual who has the agreement with the insurance company for the related policy

48.  case class InsuranceCompany(ID: Option[String] = scala.None, IDType: Option[String] = scala.None, Name: Option[String] = scala.None, Address: Option[Address] = scala.None, PhoneNumber: Option[String] = scala.None) extends Product with Serializable
    ID

    ID of insurance company (payor)

    IDType

    ID type of insurance company (payor)

    Name

    Name of insurance company (payor)

    Address

    Insurance company's address

    PhoneNumber

    Insurance companys phone number. In E. 164 Format (i.e. +16085551234)

49.  case class InsurancePlan(ID: Option[String] = scala.None, IDType: Option[String] = scala.None, Name: Option[String] = scala.None) extends Product with Serializable
    ID

    Identifier of insurance plan

    IDType

    ID type of insurance plan

    Name

    Name of insurance plan

50.  case class InsuredPerson(FirstName: Option[String] = scala.None, LastName: Option[String] = scala.None, DOB: Option[LocalDate] = scala.None, Address: Option[Address] = scala.None, Relationship: Option[String] = scala.None, PhoneNumber: Option[PhoneNumber] = scala.None) extends Product with Serializable

    Individual who has the agreement with the insurance company for the related policy

51.  case class Language(underlying: Locale) extends Product with Serializable

    This wraps java.util.Locale for consistent serialisation form language to an ISO standard language locale.

    This wraps java.util.Locale for consistent serialisation form language to an ISO standard language locale. The java implementation doesn't guarantee the validation of the input and the json formats gets masked by play-json's implementation that doesn't handle validation.

52.  case class Location(Address: Address, Type: BasicCode = ..., Name: Option[String] = scala.None) extends Product with Serializable

    Location of provider or care given.

    Location of provider or care given.

    See also

    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

53.  case class Media(FileType: String, FileName: String, FileContents: String, DocumentType: String, DocumentID: String, Provider: Option[Provider] = scala.None, Authenticated: Option[String] = scala.None, Authenticator: Option[Provider] = scala.None, Availability: MediaAvailability.Value = MediaAvailability.defaultValue, Notifications: Seq[Provider] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
    FileType

    File type of the document. E.g. PDF, JPG

    FileName

    Name of the file

    FileContents

    (Base64) @see [Redox BLOB URI](http://docs.redoxengine.com/developer-documentation/sending-files-through-redox)

    DocumentType

    Type of Document. This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)

    DocumentID

    Unique identifier for this document. This ID is required in order to update the document

    Provider

    ID of the Provider responsible for the document

    Authenticated

    The authenticated status of the document. True or False. If True, Media.Authenticator must be filled out.

    Authenticator

    The provider who authenticated the document

    Availability

    Whether the document is available. Either: Available or Unavailable

    Notifications

    List of providers that should be notified when this document posts to the patient's chart

54.  case class MediaMessage(Meta: Meta, Patient: Patient, Media: Media, Visit: Option[VisitInfo] = scala.None) extends MetaLike with HasVisitInfo with HasPatient with Product with Serializable
    Visit

    Only Visit.VisitNumber A VisitNumber is highly recommended so that the document can be associated with a specific visit

55.  case class MedicalEquipment(Status: String, StartDate: Option[DateTime] = scala.None, Quantity: Option[String] = scala.None, Product: BasicCode = ...) extends Product with Serializable

    Piece of medical equipment.

    Piece of medical equipment.

    Status

    The current status of the equipment (active, completed, etc.)

    StartDate

    When the equipment was first put into use. ISO 8601 Format

    Quantity

    The number of products used

    Product

    A code representing the actual product. SNOMED CT

56.  case class MedicalEquipmentMessage(MedicalEquipmentText: Option[String] = scala.None, MedicalEquipment: Seq[MedicalEquipment] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

    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.

    MedicalEquipmentText

    Free text form of the medical equipment summary

    MedicalEquipment

    A list of medical equipment that the patient uses (cane, pacemakers, etc.)

57.  trait Medication extends DateRange

    Created by apatzer on 3/17/17.

58.  case class MedicationOrder(ID: String, Notes: Seq[String] = scala.collection.Seq.empty[Nothing], Medication: OrderedMedication, Indications: Option[BasicCode], Provider: Option[OrderProvider] = scala.None, EnteredBy: Option[Provider] = scala.None, VerifiedBy: Option[Provider] = scala.None, Priority: Option[String] = scala.None, Pharmacy: Option[Pharmacy] = scala.None) extends Product with Serializable
    ID

    ID assigned by the ordering system

    Notes

    Order-level notes

    Indications

    This field identifies the condition or problem for which the drug/treatment was prescribed.

    Priority

    Priority of the order.

    Pharmacy

    The pharmacy at which the medication should be dispensed.

59.  case class MedicationPlan(Status: Option[String] = scala.None, Dose: Option[Dose] = scala.None, Rate: Option[Dose] = scala.None, Route: Option[BasicCode] = scala.None, StartDate: DateTime, EndDate: Option[DateTime] = scala.None, Frequency: Option[TimePeriod] = scala.None, Product: BasicCode = ...) extends Medication with Status with DateRange with Product with Serializable

    Medication to be given.

60.  case class MedicationTaken(Prescription: Boolean, FreeTextSig: Option[String] = scala.None, Dose: Option[Dose] = scala.None, Rate: Option[Dose] = scala.None, Route: Option[BasicCode] = scala.None, StartDate: DateTime, EndDate: Option[DateTime] = scala.None, Frequency: Option[TimePeriod] = scala.None, Product: BasicCode = ...) extends Medication with Product with Serializable
    Prescription

    Whether the medication is a prescription. For a prescription: true. For a patient reported med, or a med administered by a provider: false

    FreeTextSig

    Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication

61.  case class MedicationsMessage(Meta: Meta, Patient: Patient, Visit: Visit, Order: MedicationOrder) extends Product with Serializable

    The Medications data model allows real-time notification of new prescriptions and modifications or cancellations to existing ones.

62.  case class Meta(DataModel: DataModelTypes.Value, EventType: RedoxEventTypes.Value, EventDateTime: Option[DateTime] = scala.None, Test: Option[Boolean] = scala.None, Source: Option[SourceDestination] = scala.None, Destinations: Seq[SourceDestination] = scala.collection.Seq.empty[Nothing], Message: Option[NumericIdentifier] = scala.None, Transmission: Option[NumericIdentifier] = scala.None, FacilityCode: Option[String] = scala.None, IsIncomplete: Option[Boolean] = scala.None, CanceledEvent: Option[RedoxEventTypes.Value] = scala.None) extends Product with Serializable

    Request/response header meta-data

    Request/response header meta-data

    DataModel

    Data model. E.g. Scheduling, Results

    EventType

    Type of event. E.g. New, Update

    EventDateTime

    DateTime of the event. ISO 8601 Format

    Test

    Flag as a test message

    Source

    Where the message originated. Included in messages from Redox

    Destinations

    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

    Message

    Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    Transmission

    Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    FacilityCode

    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.

    IsIncomplete

    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.

    CanceledEvent

    Type of event being canceled. E.g. Arrival, Discharge, PreAdmit

63.  trait MetaLike extends AnyRef
64.  case class Note(ContentType: NoteContentTypes.Value = NoteContentTypes.defaultValue, FileName: Option[String] = scala.None, FileContents: Option[String] = scala.None, Components: Seq[NoteComponent] = scala.collection.Seq.empty[Nothing], DocumentType: String, DocumentID: String, ServiceDateTime: Option[DateTime] = scala.None, DocumentationDateTime: Option[DateTime] = scala.None, Provider: Provider, Status: Option[String] = scala.None, Authenticator: Option[Provider] = scala.None, Notifications: Seq[Provider] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
65.  case class NoteComponent(ID: Option[String] = scala.None, Name: Option[String] = scala.None, Value: Option[String] = scala.None, Comments: Option[String] = scala.None) extends Product with Serializable
    ID

    The ID of the discrete note component. A report ID, or documentation field ID

    Name

    The name of the discrete note component. e.g. 'Severity'

    Value

    The text of the note component. Plain text or RTF

    Comments

    Additional comments for the discrete note field

66.  case class NoteMessage(Meta: Meta, Patient: Patient, Visit: Option[VisitInfo] = scala.None, Note: Note, Orders: Seq[NoteOrder] = scala.collection.Seq.empty[Nothing]) extends MetaLike with HasPatient with HasVisitInfo with Product with Serializable
    Visit

    Requires only VisitNumber + VisitDateTime

67.  case class NoteOrder(ID: String, Name: Option[String] = scala.None) extends Product with Serializable
    ID

    ID of the order assigned by the placing system

    Name

    Name of the order assigned by the placing system

68.  case class NumericIdentifier(ID: Long) extends Product with Serializable
69.  sealed trait Observation extends DateStamped with Status
70.  sealed trait ObservationInterpretation extends AnyRef
71.  sealed trait ObservationValue extends AnyRef
72.  case class Order(ID: String, TransactionDateTime: Option[DateTime] = scala.None, CollectionDateTime: Option[DateTime] = scala.None, Specimen: Option[Specimen] = scala.None, Procedure: Option[BasicCodeset] = scala.None, Provider: Option[OrderProvider] = scala.None, OrderingFacility: Option[OrderingFacility] = scala.None, Priority: Option[OrderPriorityTypes.Value] = scala.None, Expiration: Option[LocalDate] = scala.None, Comments: Option[String] = scala.None, Notes: Seq[String] = scala.collection.Seq.empty[Nothing], Diagnoses: Seq[CodesetWithName] = scala.collection.Seq.empty[Nothing], ClinicalInfo: Seq[ClinicalInfo] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

    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

    ID of the order assigned by the placing system

    TransactionDateTime

    DateTime the order was placed

    CollectionDateTime

    DateTime the specimen was collected

    Specimen

    Source of the specimen.

    Procedure

    Procedure that was ordered

    Provider

    Provider making the order

    OrderingFacility

    Facility this order was placed in

    Priority

    Priority of the order. One of the following: "Stat", "ASAP", "Routine", "Preoperative", "Timing Critical".

    Expiration

    Date when the order becomes invalid. In YYYY-MM-DD format

    Comments

    Clinically relevant comments regarding the order

    Notes

    Order-level notes

    Diagnoses

    List of diagnoses associated with this order

    ClinicalInfo

    List of supplementary clinical information associated with the order. Often these are answers to Ask at Order Entry (AOE) questions.

73.  case class OrderMessage(Meta: Meta, Patient: Patient, Visit: Option[VisitInfo] = scala.None, Order: Order) extends MetaLike with OrdersMessageLike with Product with Serializable
74.  case class OrderProducer(ID: Option[String] = scala.None, IDType: Option[String] = scala.None, Name: Option[String] = scala.None, Address: Option[Address] = scala.None) extends Product with Serializable

    The "Producer" is typically the Lab which did the resulting.

75.  case class OrderProvider(NPI: Option[String] = scala.None, FirstName: Option[String] = scala.None, LastName: Option[String] = scala.None, Type: Option[String] = scala.None, Credentials: Seq[String] = scala.collection.Seq.empty[Nothing], Address: Option[Address] = scala.None, Location: Option[CareLocation] = scala.None, PhoneNumber: Option[PhoneNumber] = scala.None, EmailAddresses: Seq[String] = scala.collection.Seq.empty[Nothing], Role: Option[BasicCode] = scala.None) extends ProviderLike with Product with Serializable
    NPI

    A National Provider Identifier or NPI is a unique 10-digit identification number issued to health care providers in the United States

76.  case class OrderResult(ID: String, ApplicationOrderID: Option[String] = scala.None, TransactionDateTime: Option[DateTime] = scala.None, CollectionDateTime: Option[DateTime] = scala.None, CompletionDateTime: Option[DateTime] = scala.None, Notes: Seq[String] = scala.collection.Seq.empty[Nothing], ResultsStatus: Option[ResultsStatusTypes.Value] = scala.None, Procedure: Option[BasicCodeset] = scala.None, Provider: Option[Provider] = scala.None, Status: String, ResponseFlag: Option[String] = scala.None, Priority: Option[OrderPriorityTypes.Value] = scala.None, Results: Seq[Result] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

    Results from an Order

    Results from an Order

    ID

    ID of the order assigned by the placing system

    ApplicationOrderID

    ID assigned by the application fulfilling the order

    TransactionDateTime

    DateTime at which the order status was updated.

    CollectionDateTime

    DateTime the specimen was collected

    CompletionDateTime

    Date and time the results were composed into a report and released.

    Notes

    Order-level notes

    ResultsStatus

    Current overall status of the order. One of the following: "Final", "Preliminary", "In Process", "Corrected", "Canceled".

    Procedure

    Procedure that was ordered

    Provider

    Provider making the order

    Status

    Current status of the order. The default value is "Resulted".

    ResponseFlag

    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

    Priority of the order. One of the following: "Stat", "ASAP", "Routine", "Preoperative", "Timing Critical".

    Results

    List of result components and their values

77.  case class OrderedMedication(Dose: Option[Dose] = scala.None, Rate: Option[Dose] = scala.None, Route: Option[BasicCode] = scala.None, Product: BasicCode, FreeTextSig: Option[String] = scala.None, StartDate: DateTime, EndDate: Option[DateTime] = scala.None, Frequency: Option[TimePeriod] = scala.None, IsPRN: Option[Boolean] = scala.None) extends Medication with Product with Serializable
    Dose

    The size of the dose for pills, capsules, etc (UCUM Units of Measure).

    Rate

    If the medication is in liquid form, the rate at which it is administered (UCUM Units of Measure).

    Route

    Method by which the medication is delivered (Medication Route FDA Value Set).

    Product

    A code describing the actual medication given.

    FreeTextSig

    Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication.

    StartDate

    When the medication should be started (ISO 8601 Format).

    EndDate

    When the medication should be ended (ISO 8601 Format).

    Frequency

    How often the patient should be taking the medication.

    IsPRN

    Whether the medication is to be taken on an as-needed basis.

78.  case class OrderingFacility(Name: Option[String] = scala.None, Address: Option[Address] = scala.None, PhoneNumber: Option[String] = scala.None) extends Product with Serializable

    Facility this order was placed in

79.  trait OrdersMessageLike extends HasPatient with HasVisitInfo
80.  case class Patient(Identifiers: Seq[Identifier] = scala.collection.Seq.empty[Nothing], Demographics: Option[Demographics] = scala.None, Notes: Seq[String] = scala.collection.Seq.empty[Nothing], Contacts: Seq[Contact] = scala.collection.Seq.empty[Nothing], Guarantor: Option[Guarantor] = scala.None, Insurances: Seq[Insurance] = scala.collection.Seq.empty[Nothing], Diagnoses: Seq[CodesetWithName] = scala.collection.Seq.empty[Nothing], PCP: Option[Provider] = scala.None) extends Product with Serializable

    Patient

81.  case class PatientAdminMessage(Meta: Meta, Patient: Patient, Visit: Option[VisitInfo] = scala.None) extends MetaLike with HasPatient with HasVisitInfo with Product with Serializable

    Meta.DataModel: "PatientAdmin", Meta.EventType: {Arrival, Cancel, Discharge, NewPatient, PatientUpdate, PatientMerge, PreAdmit, Registration, Transfer, VisitMerge, VisitUpdate}

82.  case class PatientQuery(Meta: Meta, Patient: Patient) extends HasPatient with Product with Serializable
    Meta

    Message header

    Patient

    List of IDs and IDTypes for the patient

83.  case class PatientSearch(Meta: Meta, Patient: Option[Patient] = scala.None, PotentialMatches: Seq[Patient] = scala.collection.Seq.empty[Nothing]) extends MetaLike with Product with Serializable

    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}

84.  case class Pharmacy(Code: Option[String] = scala.None, Codeset: Option[String] = scala.None, Description: Option[String] = scala.None, Address: Option[Address] = scala.None) extends Product with Serializable
    Code

    Code for the pharmacy.

    Codeset

    Code set used to identify the pharmacy.

    Description

    Description of the pharmacy.

    Address

    The physical location at which the medication should be dispensed.

85.  case class PhoneNumber(Home: Option[String] = scala.None, Mobile: Option[String] = scala.None, Office: Option[String] = scala.None) extends Product with Serializable
86.  case class PlanOfCare(Orders: Seq[CodeWithStatus] = scala.collection.Seq.empty[Nothing], Procedures: Seq[CodeWithStatus] = scala.collection.Seq.empty[Nothing], Encounters: Seq[CodeWithStatus] = scala.collection.Seq.empty[Nothing], MedicationAdministration: Seq[MedicationPlan] = scala.collection.Seq.empty[Nothing], Supplies: Seq[CodeWithStatus] = scala.collection.Seq.empty[Nothing], Services: Seq[CodeWithStatus] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
    Orders

    Future lab tests or other diagnostic procedure.

    Procedures

    These are procedures that alter the state of the body, such as an appendectomy or hip replacement. SNOMED CT

    Encounters

    The encounter type that is planned. SNOMED CT

    MedicationAdministration

    Medications planned.

    Supplies

    Future supplies that a patient may be given, including implants. SNOMED CT

    Services

    These are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient. SNOMED CT

    See also

    PlanOfCareMessage

87.  case class PlanOfCareMessage(PlanOfCareText: Option[String] = scala.None, PlanOfCare: PlanOfCare) extends Product with Serializable

    This section contains future appointments, medications, orders, procedures, and services that a patient may be scheduled for or is waiting to be scheduled for.

88.  case class Pregnancy(StartDate: DateTime, EndDate: Option[DateTime] = scala.None, EstimatedDelivery: Option[String] = scala.None) extends DateRange with Product with Serializable
    StartDate

    When the pregnancy started. ISO 8601 Format

    EndDate

    When the pregnancy ended. ISO 8601 Format

    EstimatedDelivery

    Estimate delivery date if pregnancy is still active.

89.  case class Problem(StartDate: Option[DateTime] = scala.None, EndDate: Option[DateTime] = scala.None, Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Category: BasicCode = ..., Status: Option[BasicCode] = scala.None) extends Code with Product with Serializable
    StartDate

    When the problem was noticed. ISO 8601 Format

    EndDate

    When the problem stopped (if it is not current). ISO 8601 Format

    Code

    The code for the problem. . SNOMED-CT Code. Limited to terms descending from the Clinical Findings (404684003) or Situation with Explicit Context (243796009)

    Category

    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

    Status

    The current state of the problem (active, inactive, resolved). HITSPProblemStatus

90.  case class ProblemsMessage(ProblemsText: Option[String] = scala.None, Problems: Seq[Problem] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

    This section contains the patient's past and current relevant medical problems.

    This section contains the patient's past and current relevant medical problems.

    ProblemsText

    Free text form of the problems summary

    Problems

    An array of all of patient relevant problems, current and historical.

91.  case class ProcedureObservation(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, DateTime: DateTime, Status: Option[String] = scala.None, TargetSite: Option[BasicCode] = scala.None) extends ClinicalSummaryObservation with Product with Serializable

    Procedure observation

    Procedure observation

    Used within ClinicalSummary's Procedures.Observations[]. Has no units.

92.  case class Procedures(Observations: Seq[ProcedureObservation] = scala.collection.Seq.empty[Nothing], Procedures: Seq[CodeWithStatus] = scala.collection.Seq.empty[Nothing], Services: Seq[CodeWithStatus] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
    Observations

    These are procedures that are more observational in nature, such as an EEG or EKG.

    Procedures

    The procedure that was performed. SNOMED CT

    Services

    These are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient.

93.  case class ProceduresMessage(ProceduresText: Option[String] = scala.None, Procedures: Procedures) extends Product with Serializable

    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.

    ProceduresText

    Free text form of the procedures summary

    Procedures

    A general grouper for all things that CDA considers procedures.

94.  case class Provider(ID: Option[String] = scala.None, IDType: Option[String] = scala.None, FirstName: Option[String] = scala.None, LastName: Option[String] = scala.None, Type: Option[String] = scala.None, Credentials: Seq[String] = scala.collection.Seq.empty[Nothing], Address: Option[Address] = scala.None, Location: Option[CareLocation] = scala.None, PhoneNumber: Option[PhoneNumber] = scala.None, EmailAddresses: Seq[String] = scala.collection.Seq.empty[Nothing], Role: Option[BasicCode] = scala.None) extends ProviderLike with Product with Serializable

    Provider responsible for a Document

    Provider responsible for a Document

    ID

    ID of the Provider responsible for the document. This ID is required for Inpatient Visits

    IDType

    ID type of the ID for the Provider responsible for the document

    FirstName

    First name of the Provider responsible for the document

    LastName

    Last name of the Provider responsible for the document

    Type

    The type of provider for this referral. One of the following: "Referring Provider", "Referred To Provider", "Other", "Patient PCP"

    Credentials

    List of credentials for the Provider responsible for the document. e.g. MD, PhD

    Address

    Provider's address

95.  trait ProviderLike extends AnyRef
96.  case class ReferenceRange(Low: Option[Double] = scala.None, High: Option[Double] = scala.None, Text: Option[String] = scala.None) extends Product with Serializable

    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.

    Low

    Lower bound for a normal result

    High

    Upper bound for a normal result

    Text

    The normal value for non-numeric results

97.  case class Relation(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Demographics: FamilyDemographics = ..., IsDeceased: Option[Boolean] = scala.None) extends Code with Product with Serializable
98.  case class RelationDemographics(Sex: SexType.Value = SexType.defaultValue, DOB: LocalDate) extends Product with Serializable
    Sex

    Relation gender

    DOB

    Date of Birth of the relative. In YYYY-MM-DD format

99.  case class Result(Code: String, Codeset: Option[String] = scala.None, Description: Option[String] = scala.None, Specimen: Option[Specimen] = scala.None, Value: String, ValueType: ValueTypes.Value = ValueTypes.defaultValue, FileType: Option[String] = scala.None, Units: Option[String] = scala.None, Notes: Seq[String] = scala.collection.Seq.empty[Nothing], AbnormalFlag: Option[String] = scala.None, Status: Option[String] = scala.None, Producer: Option[OrderProducer] = scala.None, Performer: Option[ResultPerformer] = scala.None, ReferenceRange: Option[ReferenceRange] = scala.None, ObservationMethod: Option[BasicCodeset] = scala.None) extends Product with Serializable

    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

    Value of the result component. If ValueType is "Encapsulated Data" this field includes the Redox BLOB URI

    ValueType

    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).

    FileType

    If ValueType is "Encapsulated Data", this field includes the type of file. E.g. PDF, JPG

    Units

    Units of the result

    Notes

    Notes about the result component/observation

    AbnormalFlag

    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.

    Status

    Current status of the result. One of the following: "Final", "Incomplete", "Preliminary", "Corrected", "Preliminary"

    Producer

    The "Producer" is typically the Lab which did the resulting.

    Performer

    The provider who produced this result

    ReferenceRange

    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.

    ObservationMethod

    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.

100.  case class ResultObservation(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Status: Option[String] = scala.None, Interpretation: Option[String] = scala.None, DateTime: DateTime, CodedValue: Option[BasicCode] = scala.None, Value: Option[String] = scala.None, ValueType: Option[ValueTypes.Value] = scala.None, Units: Option[String] = scala.None, ReferenceRange: Option[ReferenceRange] = scala.None) extends ClinicalSummaryObservation with ObservationInterpretation with ObservationValue with Product with Serializable

     Result observation

     Result observation

     Used within ClincialSummary's Results[].Observations[]

101.  case class ResultPerformer(ID: Option[String], IDType: Option[String], FirstName: Option[String], LastName: Option[String], Type: Option[String], Credentials: Seq[String] = scala.collection.Seq.empty[Nothing], Address: Option[Address] = scala.None, Location: Option[CareLocation] = scala.None, PhoneNumber: Option[String] = scala.None) extends ProviderLike with Product with Serializable

     Person who produced the order result.

102.  case class ResultsMessage(Meta: Meta, Patient: Patient, Orders: Seq[OrderResult] = scala.collection.Seq.empty[Nothing], Visit: Option[VisitInfo] = scala.None) extends MetaLike with HasPatient with HasVisitInfo with Product with Serializable

     Results messages communicate results of diagnostic tests such as labs, radiology imaging, etc.

103.  case class SocialHistory(Observations: Seq[SocialHistoryObservation] = scala.collection.Seq.empty[Nothing], Pregnancy: Seq[Pregnancy] = scala.collection.Seq.empty[Nothing], TobaccoUse: Seq[TobaccoUse] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
104.  case class SocialHistoryMessage(SocialHistoryText: Option[String] = scala.None, SocialHistory: SocialHistory) extends Product with Serializable

     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.

     SocialHistoryText

     Free text form of the social history summary

     SocialHistory

     Generic observations about the patient's social hisotry that don't fall into the smoking or pregnancy categories.

105.  case class SocialHistoryObservation(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, StartDate: DateTime, EndDate: Option[DateTime] = scala.None, Value: Option[BasicCode] = scala.None, ValueText: Option[String] = scala.None) extends Code with DateRange with Product with Serializable
     Code

     A code for the observation (exercise, alcohol intake, etc.) . SNOMED CT

     Value

     The coded observed value for the code

     ValueText

     The observed value for the code

106.  case class SourceDestination(ID: UUID, Name: Option[String] = scala.None) extends Product with Serializable
107.  case class Specimen(Source: Option[String] = scala.None, BodySite: Option[String] = scala.None, ID: Option[String] = scala.None) extends Product with Serializable
     Source

     Source of the specimen. [Allowed values](http://phinvads.cdc.gov/vads/ViewValueSet.action?id=C9271C18-7B67-DE11-9B52-0015173D1785)

     BodySite

     Body site from which the specimen was collected. [Allowed values](http://www.hl7.org/FHIR/v2/0163/index.html)

     ID

     ID of the collected specimen

108.  trait Status extends AnyRef

     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)

109.  case class TimePeriod(Period: Option[String] = scala.None, Unit: Option[String] = scala.None) extends Product with Serializable

     Time period for medication.

     Time period for medication.

     Period

     How often the patient should be taking the medication.

     Unit

     Units for how often the patient should be taking the medication

     See also

     [UCUM Units of Measure](http://unitsofmeasure.org/ucum.html)

110.  case class TobaccoUse(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, StartDate: Option[DateTime] = scala.None, EndDate: Option[DateTime] = scala.None) extends Code with Product with Serializable
     Code

     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

     StartDate

     Start date of status

     EndDate

     Date status ended. If this is null, the status is current.

111.  case class Upload(URI: String) extends Product with Serializable

112.  case class Visit(Meta: Meta, Header: Header, AllergyText: Option[String] = scala.None, Allergies: Seq[Allergy] = scala.collection.Seq.empty[Nothing], AssessmentText: Option[String] = scala.None, Assessment: Option[Assessment] = scala.None, ChiefComplaintText: Option[String] = scala.None, Encounters: Seq[Encounter] = scala.collection.Seq.empty[Nothing], HistoryOfPresentIllness: Option[String] = scala.None, MedicationsText: Option[String] = scala.None, Medications: Seq[MedicationTaken] = scala.collection.Seq.empty[Nothing], PhysicalExamText: Option[String] = scala.None, PlanOfCare: Option[PlanOfCare] = scala.None, ProblemsText: Option[String] = scala.None, Problems: Seq[Problem] = scala.collection.Seq.empty[Nothing], ReasonForVisitText: Option[String] = scala.None, ResultText: Option[String] = scala.None, Results: Seq[ChartResult] = scala.collection.Seq.empty[Nothing], ReviewOfSystemsText: Option[String] = scala.None, SubjectiveText: Option[String] = scala.None, VitalSignsText: Option[String] = scala.None, VitalSigns: Seq[VitalSigns] = scala.collection.Seq.empty[Nothing]) extends ClinicalSummaryLike with Product with Serializable

     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

     AllergyText

     Free text form of the allergies summary

     Allergies

     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)

     AssessmentText

     Free text of the clinician's conclusions and working assumptions that will guide treatment of the patient

     Assessment

     An array of diagnoses

     ChiefComplaintText

     Free text chief complaint with any documented exposition

     Encounters

     A code describing the type of encounter (office visit, hospital, etc). CPT-4

     HistoryOfPresentIllness

     Free text describing the history related to the reason for the encounter

     MedicationsText

     Free text form of the medications summary

     Medications

     Array of medications

     PhysicalExamText

     Free text regarding the physical exam, observations by clinician

     PlanOfCare

     Free text form of the plan of care summary

     ProblemsText

     Free text form of the problems summary

     Problems

     An array of all of patient relevant problems, current and historical.

     ReasonForVisitText

     Free text describing the patient's reason for the patient's visit

     ResultText

     Free text form of the results summary

     Results

     Array of test results for the patient. This can include laboratory results, imaging results, and procedure Results[].

     ReviewOfSystemsText

     Free text about symptoms and wellbeing of the patient

     SubjectiveText

     Free text description of the patient's condition as reported by the patient and documented by the clinician

     VitalSignsText

     Free text form of the vital signs summary

     VitalSigns

     An array of groups of vital signs. Each element represents one time period in which vitals were recorded.

113.  case class VisitInfo(VisitNumber: Option[String] = scala.None, VisitDateTime: Option[DateTime] = scala.None, Duration: Option[Double] = scala.None, Reason: Option[String] = scala.None, PatientClass: Option[PatientClassType.Value] = scala.None, Location: Option[CareLocation] = scala.None, PreviousLocation: Option[CareLocation] = scala.None, AttendingProvider: Option[Provider] = scala.None, ConsultingProvider: Option[Provider] = scala.None, ReferringProvider: Option[Provider] = scala.None, Guarantor: Option[Guarantor] = scala.None, Insurance: Option[Insurance] = scala.None, Insurances: Seq[Insurance] = scala.collection.Seq.empty[Nothing], Instructions: Seq[String] = scala.collection.Seq.empty[Nothing], Balance: Option[Double] = scala.None, Type: Option[String] = scala.None, DateTime: Option[DateTime] = scala.None, DischargeDateTime: Option[DateTime] = scala.None, DischargeStatus: Option[BasicCodeset] = scala.None, DischargeLocation: Option[CareLocation] = scala.None, StartDateTime: Option[DateTime] = scala.None, EndDateTime: Option[DateTime] = scala.None) extends Product with Serializable

     Information about the visit associate with models.Order and/or models.Result

     Information about the visit associate with models.Order and/or models.Result

     Duration

     Length of visit. In minutes

     PatientClass

     Patient class is used in many EHRs to determine where to put the patient. Examples: Inpatient, Outpatient, Emergency

     Location

     Location of the appointment

     AttendingProvider

     ID of the attending provider. This ID is required for Inpatient Visits

     Guarantor

     Person ultimately responsible for the bill of the appointment

     Insurances

     List of insurance coverages for the patient

     Instructions

     Appointment instructions

     Balance

     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.

114.  case class VisitQuery(Meta: Meta, Patient: Patient, Visit: VisitQueryParams) extends HasPatient with Product with Serializable

     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.

115.  case class VisitQueryParams(VisitNumber: Option[String] = scala.None, StartDateTime: DateTime, EndDateTime: Option[DateTime] = scala.None) extends Product with Serializable
     VisitNumber

     ID for the patient visit/encounter. Either this or a timeframe is required. If both are provided, the visit number will be used.

     StartDateTime

     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

     EndDateTime

     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

116.  case class VitalSignObservation(Code: Option[String] = scala.None, CodeSystem: Option[String] = scala.None, CodeSystemName: Option[String] = scala.None, Name: Option[String] = scala.None, Status: Option[String] = scala.None, Interpretation: Option[String] = scala.None, DateTime: DateTime, Value: Option[String] = scala.None, Units: Option[String] = scala.None) extends ClinicalSummaryObservation with ObservationInterpretation with ObservationValue with Product with Serializable

     Vital sign observation

     Vital sign observation

     Used within ClinicalSummary's VitalSigns[].Observations[]

117.  case class VitalSigns(DateTime: DateTime, Observations: Seq[VitalSignObservation] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
     DateTime

     The date and time of the reading. ISO 8601 Format

     Observations

     The type of vital sign being read (height, weight, blood pressure, etc.). Subset of LOINC codes (HITSP Vital Sign Result Type).

118.  case class VitalSignsMessage(VitalSignsText: Option[String] = scala.None, VitalSigns: Seq[VitalSigns] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable

     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.

     VitalSignsText

     Free text form of the vital signs summary

     VitalSigns

     An array of groups of vital signs. Each element represents one time period in which vitals were recorded.

119.  trait WithAddress extends AnyRef
120.  trait WithContactDetails extends WithAddress with WithPhoneNumber with WithEmails
121.  trait WithEmails extends AnyRef
122.  trait WithPhoneNumber extends AnyRef