MedicationPrescription (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.MedicationPrescription

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class MedicationPrescription
extends BaseResource
implements IResource
```
HAPI/FHIR MedicationPrescription Resource (Prescription of medication to for patient)
Definition: An order for both supply of the medication and the instructions for administration of the medicine to a patient.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/MedicationPrescription

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MedicationPrescription.Dispense` Block class for child element: MedicationPrescription.dispense (Medication supply authorization)
`static class`	`MedicationPrescription.DosageInstruction` Block class for child element: MedicationPrescription.dosageInstruction (How medication should be taken)
`static class`	`MedicationPrescription.Substitution` Block class for child element: MedicationPrescription.substitution (Any restrictions on medication substitution?)

Field Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`DATEWRITTEN` Fluent Client search parameter constant for datewritten
`static ReferenceClientParam`	`ENCOUNTER` Fluent Client search parameter constant for encounter
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_ENCOUNTER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_MEDICATION` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`MEDICATION` Fluent Client search parameter constant for medication
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static String`	`SP_DATEWRITTEN` Search parameter constant for datewritten
`static String`	`SP_ENCOUNTER` Search parameter constant for encounter
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_MEDICATION` Search parameter constant for medication
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_STATUS` Search parameter constant for status
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

MedicationPrescription()

Constructors
Constructor and Description
`MedicationPrescription()`

Method Summary

Methods
Modifier and Type	Method and Description
`MedicationPrescription.DosageInstruction`	`addDosageInstruction()` Adds and returns a new value for dosageInstruction (How medication should be taken)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (External identifier)
`MedicationPrescription`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (External identifier)
`MedicationPrescription`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (External identifier)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`DateTimeDt`	`getDateWritten()` Gets the value(s) for dateWritten (When prescription was authorized).
`MedicationPrescription.Dispense`	`getDispense()` Gets the value(s) for dispense (Medication supply authorization).
`List<MedicationPrescription.DosageInstruction>`	`getDosageInstruction()` Gets the value(s) for dosageInstruction (How medication should be taken).
`MedicationPrescription.DosageInstruction`	`getDosageInstructionFirstRep()` Gets the first repetition for dosageInstruction (How medication should be taken), creating it if it does not already exist.
`ResourceReferenceDt`	`getEncounter()` Gets the value(s) for encounter (Created during encounter / admission / stay).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (External identifier).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (External identifier), creating it if it does not already exist.
`ResourceReferenceDt`	`getMedication()` Gets the value(s) for medication (Medication to be taken).
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient (Who prescription is for).
`ResourceReferenceDt`	`getPrescriber()` Gets the value(s) for prescriber (Who ordered the medication(s)).
`IDatatype`	`getReason()` Gets the value(s) for reason[x] (Reason or indication for writing the prescription).
`BoundCodeDt<MedicationPrescriptionStatusEnum>`	`getStatus()` Gets the value(s) for status (active \| on hold \| completed \| entered in error \| stopped \| superceded).
`MedicationPrescription.Substitution`	`getSubstitution()` Gets the value(s) for substitution (Any restrictions on medication substitution?).
`boolean`	`isEmpty()`
`MedicationPrescription`	`setDateWritten(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for dateWritten (When prescription was authorized)
`MedicationPrescription`	`setDateWritten(DateTimeDt theValue)` Sets the value(s) for dateWritten (When prescription was authorized)
`MedicationPrescription`	`setDateWrittenWithSecondsPrecision(Date theDate)` Sets the value for dateWritten (When prescription was authorized)
`MedicationPrescription`	`setDispense(MedicationPrescription.Dispense theValue)` Sets the value(s) for dispense (Medication supply authorization)
`MedicationPrescription`	`setDosageInstruction(List<MedicationPrescription.DosageInstruction> theValue)` Sets the value(s) for dosageInstruction (How medication should be taken)
`MedicationPrescription`	`setEncounter(ResourceReferenceDt theValue)` Sets the value(s) for encounter (Created during encounter / admission / stay)
`MedicationPrescription`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (External identifier)
`MedicationPrescription`	`setMedication(ResourceReferenceDt theValue)` Sets the value(s) for medication (Medication to be taken)
`MedicationPrescription`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient (Who prescription is for)
`MedicationPrescription`	`setPrescriber(ResourceReferenceDt theValue)` Sets the value(s) for prescriber (Who ordered the medication(s))
`MedicationPrescription`	`setReason(IDatatype theValue)` Sets the value(s) for reason[x] (Reason or indication for writing the prescription)
`MedicationPrescription`	`setStatus(BoundCodeDt<MedicationPrescriptionStatusEnum> theValue)` Sets the value(s) for status (active \| on hold \| completed \| entered in error \| stopped \| superceded)
`MedicationPrescription`	`setStatus(MedicationPrescriptionStatusEnum theValue)` Sets the value(s) for status (active \| on hold \| completed \| entered in error \| stopped \| superceded)
`MedicationPrescription`	`setSubstitution(MedicationPrescription.Substitution theValue)` Sets the value(s) for substitution (Any restrictions on medication substitution?)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_DATEWRITTEN
```
public static final String SP_DATEWRITTEN
```
    Search parameter constant for datewritten
    Description: Return prescriptions written on this date
    Type: date
    Path: MedicationPrescription.dateWritten
    
    See Also:
    Constant Field Values
  - DATEWRITTEN
```
public static final DateClientParam DATEWRITTEN
```
    Fluent Client search parameter constant for datewritten
    Description: Return prescriptions written on this date
    Type: date
    Path: MedicationPrescription.dateWritten
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    Search parameter constant for encounter
    Description: Return prescriptions with this encounter identity
    Type: reference
    Path: MedicationPrescription.encounter
    
    See Also:
    Constant Field Values
  - ENCOUNTER
```
public static final ReferenceClientParam ENCOUNTER
```
    Fluent Client search parameter constant for encounter
    Description: Return prescriptions with this encounter identity
    Type: reference
    Path: MedicationPrescription.encounter
  - INCLUDE_ENCOUNTER
```
public static final Include INCLUDE_ENCOUNTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationPrescription.encounter".
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: Return prescriptions with this external identity
    Type: token
    Path: MedicationPrescription.identifier
    
    See Also:
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Return prescriptions with this external identity
    Type: token
    Path: MedicationPrescription.identifier
  - SP_MEDICATION
```
public static final String SP_MEDICATION
```
    Search parameter constant for medication
    Description: Code for medicine or text in medicine name
    Type: reference
    Path: MedicationPrescription.medication
    
    See Also:
    Constant Field Values
  - MEDICATION
```
public static final ReferenceClientParam MEDICATION
```
    Fluent Client search parameter constant for medication
    Description: Code for medicine or text in medicine name
    Type: reference
    Path: MedicationPrescription.medication
  - INCLUDE_MEDICATION
```
public static final Include INCLUDE_MEDICATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationPrescription.medication".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: The identity of a patient to list dispenses for
    Type: reference
    Path: MedicationPrescription.patient
    
    See Also:
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The identity of a patient to list dispenses for
    Type: reference
    Path: MedicationPrescription.patient
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationPrescription.patient".
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description: Status of the prescription
    Type: token
    Path: MedicationPrescription.status
    
    See Also:
    Constant Field Values
  - STATUS
```
public static final TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: Status of the prescription
    Type: token
    Path: MedicationPrescription.status
- Constructor Detail
  - MedicationPrescription
```
public MedicationPrescription()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (External identifier). creating it if it does not exist. Will not return null.
    Definition: External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.
  - setIdentifier
```
public MedicationPrescription setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (External identifier)
    Definition: External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (External identifier)
    Definition: External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (External identifier), creating it if it does not already exist.
    Definition: External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.
  - addIdentifier
```
public MedicationPrescription addIdentifier(IdentifierUseEnum theUse,
                                   String theSystem,
                                   String theValue,
                                   String theLabel)
```
    Adds a new value for identifier (External identifier)
    Definition: External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public MedicationPrescription addIdentifier(String theSystem,
                                   String theValue)
```
    Adds a new value for identifier (External identifier)
    Definition: External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getDateWritten
```
public DateTimeDt getDateWritten()
```
    Gets the value(s) for dateWritten (When prescription was authorized). creating it if it does not exist. Will not return null.
    Definition: The date (and perhaps time) when the prescription was written
  - setDateWritten
```
public MedicationPrescription setDateWritten(DateTimeDt theValue)
```
    Sets the value(s) for dateWritten (When prescription was authorized)
    Definition: The date (and perhaps time) when the prescription was written
  - setDateWrittenWithSecondsPrecision
```
public MedicationPrescription setDateWrittenWithSecondsPrecision(Date theDate)
```
    Sets the value for dateWritten (When prescription was authorized)
    Definition: The date (and perhaps time) when the prescription was written
  - setDateWritten
```
public MedicationPrescription setDateWritten(Date theDate,
                                    TemporalPrecisionEnum thePrecision)
```
    Sets the value for dateWritten (When prescription was authorized)
    Definition: The date (and perhaps time) when the prescription was written
  - getStatus
```
public BoundCodeDt<MedicationPrescriptionStatusEnum> getStatus()
```
    Gets the value(s) for status (active | on hold | completed | entered in error | stopped | superceded). creating it if it does not exist. Will not return null.
    Definition: A code specifying the state of the order. Generally this will be active or completed state
  - setStatus
```
public MedicationPrescription setStatus(BoundCodeDt<MedicationPrescriptionStatusEnum> theValue)
```
    Sets the value(s) for status (active | on hold | completed | entered in error | stopped | superceded)
    Definition: A code specifying the state of the order. Generally this will be active or completed state
  - setStatus
```
public MedicationPrescription setStatus(MedicationPrescriptionStatusEnum theValue)
```
    Sets the value(s) for status (active | on hold | completed | entered in error | stopped | superceded)
    Definition: A code specifying the state of the order. Generally this will be active or completed state
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (Who prescription is for). creating it if it does not exist. Will not return null.
    Definition: A link to a resource representing the person to whom the medication will be given.
  - setPatient
```
public MedicationPrescription setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient (Who prescription is for)
    Definition: A link to a resource representing the person to whom the medication will be given.
  - getPrescriber
```
public ResourceReferenceDt getPrescriber()
```
    Gets the value(s) for prescriber (Who ordered the medication(s)). creating it if it does not exist. Will not return null.
    Definition: The healthcare professional responsible for authorizing the prescription
  - setPrescriber
```
public MedicationPrescription setPrescriber(ResourceReferenceDt theValue)
```
    Sets the value(s) for prescriber (Who ordered the medication(s))
    Definition: The healthcare professional responsible for authorizing the prescription
  - getEncounter
```
public ResourceReferenceDt getEncounter()
```
    Gets the value(s) for encounter (Created during encounter / admission / stay). creating it if it does not exist. Will not return null.
    Definition: A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
  - setEncounter
```
public MedicationPrescription setEncounter(ResourceReferenceDt theValue)
```
    Sets the value(s) for encounter (Created during encounter / admission / stay)
    Definition: A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
  - getReason
```
public IDatatype getReason()
```
    Gets the value(s) for reason[x] (Reason or indication for writing the prescription). creating it if it does not exist. Will not return null.
    Definition: Can be the reason or the indication for writing the prescription.
  - setReason
```
public MedicationPrescription setReason(IDatatype theValue)
```
    Sets the value(s) for reason[x] (Reason or indication for writing the prescription)
    Definition: Can be the reason or the indication for writing the prescription.
  - getMedication
```
public ResourceReferenceDt getMedication()
```
    Gets the value(s) for medication (Medication to be taken). creating it if it does not exist. Will not return null.
    Definition: Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
  - setMedication
```
public MedicationPrescription setMedication(ResourceReferenceDt theValue)
```
    Sets the value(s) for medication (Medication to be taken)
    Definition: Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
  - getDosageInstruction
```
public List<MedicationPrescription.DosageInstruction> getDosageInstruction()
```
    Gets the value(s) for dosageInstruction (How medication should be taken). creating it if it does not exist. Will not return null.
    Definition: Indicates how the medication is to be used by the patient
  - setDosageInstruction
```
public MedicationPrescription setDosageInstruction(List<MedicationPrescription.DosageInstruction> theValue)
```
    Sets the value(s) for dosageInstruction (How medication should be taken)
    Definition: Indicates how the medication is to be used by the patient
  - addDosageInstruction
```
public MedicationPrescription.DosageInstruction addDosageInstruction()
```
    Adds and returns a new value for dosageInstruction (How medication should be taken)
    Definition: Indicates how the medication is to be used by the patient
  - getDosageInstructionFirstRep
```
public MedicationPrescription.DosageInstruction getDosageInstructionFirstRep()
```
    Gets the first repetition for dosageInstruction (How medication should be taken), creating it if it does not already exist.
    Definition: Indicates how the medication is to be used by the patient
  - getDispense
```
public MedicationPrescription.Dispense getDispense()
```
    Gets the value(s) for dispense (Medication supply authorization). creating it if it does not exist. Will not return null.
    Definition: Deals with details of the dispense part of the order
  - setDispense
```
public MedicationPrescription setDispense(MedicationPrescription.Dispense theValue)
```
    Sets the value(s) for dispense (Medication supply authorization)
    Definition: Deals with details of the dispense part of the order
  - getSubstitution
```
public MedicationPrescription.Substitution getSubstitution()
```
    Gets the value(s) for substitution (Any restrictions on medication substitution?). creating it if it does not exist. Will not return null.
    Definition: Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.
  - setSubstitution
```
public MedicationPrescription setSubstitution(MedicationPrescription.Substitution theValue)
```
    Sets the value(s) for substitution (Any restrictions on medication substitution?)
    Definition: Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.

Class MedicationPrescription

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_DATEWRITTEN

DATEWRITTEN

SP_ENCOUNTER

ENCOUNTER

INCLUDE_ENCOUNTER

SP_IDENTIFIER

IDENTIFIER

SP_MEDICATION

MEDICATION

INCLUDE_MEDICATION

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_STATUS

STATUS

Constructor Detail

MedicationPrescription

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getDateWritten

setDateWritten

setDateWrittenWithSecondsPrecision

setDateWritten

getStatus

setStatus

setStatus

getPatient

setPatient

getPrescriber

setPrescriber

getEncounter

setEncounter

getReason

setReason

getMedication

setMedication

getDosageInstruction

setDosageInstruction

addDosageInstruction

getDosageInstructionFirstRep

getDispense

setDispense

getSubstitution

setSubstitution