Private OptionalidentifierMedication.identifier Element
Private OptionalcodeMedication.code Element
FHIR Specification
CodeableConceptPrivate ReadonlymedicationFHIR CodeSystem: MedicationStatus
Private OptionalstatusMedication.status Element
FHIR Specification
codeCodeSystem Enumeration: MedicationStatusEnum
Private OptionalmanufacturerMedication.manufacturer Element
FHIR Specification
Reference
Private OptionalformMedication.form Element
FHIR Specification
CodeableConceptPrivate OptionalamountMedication.amount Element
FHIR Specification
RatioPrivate OptionalingredientMedication.ingredient Element
FHIR Specification
BackboneElementPrivate OptionalbatchMedication.batch Element
StaticparseParse the provided Medication JSON to instantiate the Medication data model.
JSON representing FHIR Medication
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Medication
Medication data model or undefined for Medication
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the code property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Code object value to the code property.
the code object value
this
InvalidTypeError for invalid data types
true if the code property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: MedicationStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: MedicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else undefined
CodeSystem Enumeration: MedicationStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: MedicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: MedicationStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: MedicationStatusEnum
true if the status property exists and has a value; false otherwise
the manufacturer property value as a Reference object; else an empty Reference object
Assigns the provided Manufacturer object value to the manufacturer property.
the manufacturer object value
this
InvalidTypeError for invalid data type or reference value
true if the manufacturer property exists and has a value; false otherwise
the form property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Form object value to the form property.
the form object value
this
InvalidTypeError for invalid data types
true if the form property exists and has a value; false otherwise
the amount property value as a Ratio object if defined; else an empty Ratio object
Assigns the provided Amount object value to the amount property.
the amount object value
this
InvalidTypeError for invalid data types
true if the amount property exists and has a value; false otherwise
the ingredient property value as a MedicationIngredientComponent array
Assigns the provided MedicationIngredientComponent array value to the ingredient property.
the ingredient array value
this
InvalidTypeError for invalid data types
Add the provided MedicationIngredientComponent value to the ingredient array property.
the ingredient value
this
InvalidTypeError for invalid data types
true if the ingredient property exists and has a value; false otherwise
the batch property value as a MedicationBatchComponent object if defined; else an empty MedicationBatchComponent object
Assigns the provided Batch object value to the batch property.
the batch object value
this
InvalidTypeError for invalid data types
true if the batch property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the ingredient property
Medication Class
Remarks
This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
FHIR Specification
See
FHIR Medication