Package org.hl7.fhir.r5.tools

Class CDSHookOrderSelectContext

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.LogicalBase
org.hl7.fhir.r5.tools.CDSHookContext
org.hl7.fhir.r5.tools.CDSHookOrderSelectContext
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType
public class CDSHookOrderSelectContext extends CDSHookContext implements org.hl7.fhir.instance.model.api.ICompositeType
This structure is defined to allow the FHIR Validator to validate a CDSHooks order-select context. TODO: This content will be moved to the CDS Hooks specification in the future
See Also:

  • Field Details

    • userId

      protected UrlType userId
      For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/123.

    • patientId

      protected IdType patientId
      The FHIR Patient.id of the current patient in context

    • encounterId

      protected IdType encounterId
      The FHIR Encounter.id of the current encounter in context

    • selectionsList

      protected List<UriType> selectionsList
      The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103

    • draftOrders

      protected Bundle draftOrders
      FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status

  • Constructor Details

  • Method Details

    • getUserIdElement

      public UrlType getUserIdElement()
      Returns:
      userId (For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/123.). This is the underlying object with id, value and extensions. The accessor "getUserId" gives direct access to the value

    • hasUserIdElement

      public boolean hasUserIdElement()

    • hasUserId

      public boolean hasUserId()

    • setUserIdElement

      public CDSHookOrderSelectContext setUserIdElement(UrlType value)
      Parameters:
      value - userId (For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/123.). This is the underlying object with id, value and extensions. The accessor "getUserId" gives direct access to the value

    • getUserId

      public String getUserId()
      Returns:
      For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/123.

    • setUserId

      public CDSHookOrderSelectContext setUserId(String value)
      Parameters:
      value - For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/123.

    • getPatientIdElement

      public IdType getPatientIdElement()
      Returns:
      patientId (The FHIR Patient.id of the current patient in context). This is the underlying object with id, value and extensions. The accessor "getPatientId" gives direct access to the value

    • hasPatientIdElement

      public boolean hasPatientIdElement()

    • hasPatientId

      public boolean hasPatientId()

    • setPatientIdElement

      public CDSHookOrderSelectContext setPatientIdElement(IdType value)
      Parameters:
      value - patientId (The FHIR Patient.id of the current patient in context). This is the underlying object with id, value and extensions. The accessor "getPatientId" gives direct access to the value

    • getPatientId

      public String getPatientId()
      Returns:
      The FHIR Patient.id of the current patient in context

    • setPatientId

      public CDSHookOrderSelectContext setPatientId(String value)
      Parameters:
      value - The FHIR Patient.id of the current patient in context

    • getEncounterIdElement

      public IdType getEncounterIdElement()
      Returns:
      encounterId (The FHIR Encounter.id of the current encounter in context). This is the underlying object with id, value and extensions. The accessor "getEncounterId" gives direct access to the value

    • hasEncounterIdElement

      public boolean hasEncounterIdElement()

    • hasEncounterId

      public boolean hasEncounterId()

    • setEncounterIdElement

      public CDSHookOrderSelectContext setEncounterIdElement(IdType value)
      Parameters:
      value - encounterId (The FHIR Encounter.id of the current encounter in context). This is the underlying object with id, value and extensions. The accessor "getEncounterId" gives direct access to the value

    • getEncounterId

      public String getEncounterId()
      Returns:
      The FHIR Encounter.id of the current encounter in context

    • setEncounterId

      public CDSHookOrderSelectContext setEncounterId(String value)
      Parameters:
      value - The FHIR Encounter.id of the current encounter in context

    • getSelectionsList

      public List<UriType> getSelectionsList()
      Returns:
      invalid reference 
      #selections
      (The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103)

    • setSelectionsList

      public CDSHookOrderSelectContext setSelectionsList(List<UriType> theSelections)
      Returns:
      Returns a reference to this for easy method chaining

    • hasSelections

      public boolean hasSelections()

    • addSelectionsElement

      public UriType addSelectionsElement()
      Returns:
      invalid reference 
      #selections
      (The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103)

    • addSelections

      public CDSHookOrderSelectContext addSelections(String value)
      Parameters:
      value -
      invalid reference 
      #selections
      (The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103)

    • hasSelections

      public boolean hasSelections(String value)
      Parameters:
      value -
      invalid reference 
      #selections
      (The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103)

    • getDraftOrders

      public Bundle getDraftOrders()
      Returns:
      draftOrders (FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status)

    • hasDraftOrders

      public boolean hasDraftOrders()

    • setDraftOrders

      public CDSHookOrderSelectContext setDraftOrders(Bundle value)
      Parameters:
      value - draftOrders (FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status)

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Base

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class CDSHookContext
      Returns:
      the FHIR type name of the instance (not the java class name)

    • copy

      public CDSHookOrderSelectContext copy()
      Specified by:
      copy in class CDSHookContext

    • copyValues

      public void copyValues(CDSHookOrderSelectContext dst)

    • typedCopy

      protected CDSHookOrderSelectContext typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Base

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Base

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Base