Package org.hl7.fhir.r5.tools

Class CDSHookOrderSignContext

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

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 CDSHookOrderSignContext
extends CDSHookContext
implements org.hl7.fhir.instance.model.api.ICompositeType

This structure is defined to allow the FHIR Validator to validate a CDSHooks Order-Sign context. TODO: This content will be moved to the CDS Hooks specification in the future

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected Bundle	draftOrders	FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status
protected IdType	encounterId	The FHIR Encounter.id of the current encounter in context
protected IdType	patientId	The FHIR Patient.id of the current patient in context
protected UrlType	userId	For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson.

Constructor Summary

Constructors

Constructor	Description
CDSHookOrderSignContext()	Constructor
CDSHookOrderSignContext(String userId, String patientId, Bundle draftOrders)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CDSHookOrderSignContext	copy()
void	copyValues(CDSHookOrderSignContext dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Bundle	getDraftOrders()
String	getEncounterId()
IdType	getEncounterIdElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getPatientId()
IdType	getPatientIdElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
String	getUserId()
UrlType	getUserIdElement()
boolean	hasDraftOrders()
boolean	hasEncounterId()
boolean	hasEncounterIdElement()
boolean	hasPatientId()
boolean	hasPatientIdElement()
boolean	hasUserId()
boolean	hasUserIdElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CDSHookOrderSignContext	setDraftOrders(Bundle value)
CDSHookOrderSignContext	setEncounterId(String value)
CDSHookOrderSignContext	setEncounterIdElement(IdType value)
CDSHookOrderSignContext	setPatientId(String value)
CDSHookOrderSignContext	setPatientIdElement(IdType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CDSHookOrderSignContext	setUserId(String value)
CDSHookOrderSignContext	setUserIdElement(UrlType value)
protected CDSHookOrderSignContext	typedCopy()

Methods inherited from class org.hl7.fhir.r5.tools.CDSHookContext

copyValues

Methods inherited from class org.hl7.fhir.r5.model.LogicalBase

getFHIRPublicationVersion, getIdBase, setIdBase

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, removeChild, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

draftOrders

protected Bundle draftOrders

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

Constructor Details

CDSHookOrderSignContext

public CDSHookOrderSignContext()

Constructor

CDSHookOrderSignContext

public CDSHookOrderSignContext(String userId,
 String patientId,
 Bundle draftOrders)

Constructor

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 CDSHookOrderSignContext 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 CDSHookOrderSignContext 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 CDSHookOrderSignContext 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 CDSHookOrderSignContext 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 CDSHookOrderSignContext 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 CDSHookOrderSignContext setEncounterId(String value)

Parameters:

value - The FHIR Encounter.id of the current encounter in context

getDraftOrders

public Bundle getDraftOrders()

Returns:

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

hasDraftOrders

public boolean hasDraftOrders()

setDraftOrders

public CDSHookOrderSignContext 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 CDSHookOrderSignContext copy()

Specified by:

copy in class CDSHookContext

copyValues

public void copyValues(CDSHookOrderSignContext dst)

typedCopy

protected CDSHookOrderSignContext 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