Private Optionaltype_Provenance.agent.type Element
Private OptionalroleProvenance.agent.role Element
FHIR Specification
CodeableConceptPrivatewhoProvenance.agent.who Element
FHIR Specification
Reference
Private OptionalonProvenance.agent.onBehalfOf Element
FHIR Specification
Reference
StaticparseParse the provided ProvenanceAgentComponent JSON to instantiate the ProvenanceAgentComponent data model.
JSON representing FHIR ProvenanceAgentComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ProvenanceAgentComponent
ProvenanceAgentComponent data model or undefined for ProvenanceAgentComponent
JsonError if the provided JSON is not a valid JSON object
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Type object value to the type_ property.
the type_ object value
this
InvalidTypeError for invalid data types
true if the type_ property exists and has a value; false otherwise
the role property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the role property.
the role array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the role array property.
the role value
this
InvalidTypeError for invalid data types
true if the role property exists and has a value; false otherwise
the who property value as a Reference object if defined; else an empty Reference object
Assigns the provided Who object value to the who property.
the who object value
this
@ReferenceTargets('Provenance.agent.who', ['Practitioner','PractitionerRole','RelatedPerson','Patient','Device','Organization',])
InvalidTypeError for invalid data type or reference value
true if the who property exists and has a value; false otherwise
the onBehalfOf property value as a Reference object; else an empty Reference object
Assigns the provided OnBehalfOf object value to the onBehalfOf property.
the onBehalfOf object value
this
@ReferenceTargets('Provenance.agent.onBehalfOf', ['Practitioner','PractitionerRole','RelatedPerson','Patient','Device','Organization',])
InvalidTypeError for invalid data type or reference value
true if the onBehalfOf property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; 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
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 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; 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 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 id property value
Assigns the provided value to the id property.
the id value
this
PrimitiveTypeError for invalid value
true if id 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
Determines if the extension property exists.
the url that identifies a specific Extension
an Extension having 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 extension property exists and has any values.
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
true if the instance is a FHIR resource; 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 role property
ProvenanceAgentComponent Class
Remarks
FHIR Specification
See
FHIR Provenance