FhirResource
class FhirResource : Parcelable
| kotlin.Any | |
| ↳ | android.health.connect.datatypes.FhirResource |
A class to capture the FHIR resource data. This is the class used for all supported FHIR resource types, which is a subset of the resource list on the official FHIR website. The list of supported types will likely expand in future releases.
FHIR stands for the Fast Healthcare Interoperability Resources standard.
Summary
| Nested classes | |
|---|---|
|
Builder class for |
|
| Constants | |
|---|---|
| static Int |
FHIR resource type for AllergyIntolerance. |
| static Int |
FHIR resource type for a FHIR Condition. |
| static Int |
FHIR resource type for a FHIR Encounter. |
| static Int |
FHIR resource type for Immunization. |
| static Int |
FHIR resource type for a FHIR Location. |
| static Int |
FHIR resource type for a FHIR Medication. |
| static Int |
FHIR resource type for a FHIR MedicationRequest. |
| static Int |
FHIR resource type for a FHIR MedicationStatement. |
| static Int |
FHIR resource type for a FHIR Observation. |
| static Int |
FHIR resource type for a FHIR Organization. |
| static Int |
FHIR resource type for a FHIR Patient. |
| static Int |
FHIR resource type for a FHIR Practitioner. |
| static Int |
FHIR resource type for a FHIR PractitionerRole. |
| static Int |
FHIR resource type for a FHIR Procedure. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| String |
getData()Returns the FHIR resource data in JSON representation. |
| String |
getId()Returns the FHIR resource ID. |
| Int |
getType()Returns the FHIR resource type. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<FhirResource!> | |
Constants
FHIR_RESOURCE_TYPE_ALLERGY_INTOLERANCE
static val FHIR_RESOURCE_TYPE_ALLERGY_INTOLERANCE: Int
FHIR resource type for AllergyIntolerance.
Value: 2FHIR_RESOURCE_TYPE_CONDITION
static val FHIR_RESOURCE_TYPE_CONDITION: Int
FHIR resource type for a FHIR Condition.
Value: 4FHIR_RESOURCE_TYPE_ENCOUNTER
static val FHIR_RESOURCE_TYPE_ENCOUNTER: Int
FHIR resource type for a FHIR Encounter.
Value: 12FHIR_RESOURCE_TYPE_IMMUNIZATION
static val FHIR_RESOURCE_TYPE_IMMUNIZATION: Int
FHIR resource type for Immunization.
Value: 1FHIR_RESOURCE_TYPE_LOCATION
static val FHIR_RESOURCE_TYPE_LOCATION: Int
FHIR resource type for a FHIR Location.
Value: 13FHIR_RESOURCE_TYPE_MEDICATION
static val FHIR_RESOURCE_TYPE_MEDICATION: Int
FHIR resource type for a FHIR Medication.
Value: 6FHIR_RESOURCE_TYPE_MEDICATION_REQUEST
static val FHIR_RESOURCE_TYPE_MEDICATION_REQUEST: Int
FHIR resource type for a FHIR MedicationRequest.
Value: 7FHIR_RESOURCE_TYPE_MEDICATION_STATEMENT
static val FHIR_RESOURCE_TYPE_MEDICATION_STATEMENT: Int
FHIR resource type for a FHIR MedicationStatement.
Value: 8FHIR_RESOURCE_TYPE_OBSERVATION
static val FHIR_RESOURCE_TYPE_OBSERVATION: Int
FHIR resource type for a FHIR Observation.
Value: 3FHIR_RESOURCE_TYPE_ORGANIZATION
static val FHIR_RESOURCE_TYPE_ORGANIZATION: Int
FHIR resource type for a FHIR Organization.
Value: 14FHIR_RESOURCE_TYPE_PATIENT
static val FHIR_RESOURCE_TYPE_PATIENT: Int
FHIR resource type for a FHIR Patient.
Value: 9FHIR_RESOURCE_TYPE_PRACTITIONER
static val FHIR_RESOURCE_TYPE_PRACTITIONER: Int
FHIR resource type for a FHIR Practitioner.
Value: 10FHIR_RESOURCE_TYPE_PRACTITIONER_ROLE
static val FHIR_RESOURCE_TYPE_PRACTITIONER_ROLE: Int
FHIR resource type for a FHIR PractitionerRole.
Value: 11FHIR_RESOURCE_TYPE_PROCEDURE
static val FHIR_RESOURCE_TYPE_PROCEDURE: Int
FHIR resource type for a FHIR Procedure.
Value: 5Public methods
describeContents
fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getData
fun getData(): String
Returns the FHIR resource data in JSON representation.
| Return | |
|---|---|
String |
This value cannot be null. |
getId
fun getId(): String
Returns the FHIR resource ID. This is extracted from the "id" field in data. This is NOT a unique identifier among all FhirResources.
| Return | |
|---|---|
String |
This value cannot be null. |
getType
fun getType(): Int
Returns the FHIR resource type. This is extracted from the "resourceType" field in getData.
The list of supported types is a subset of the resource list on the official FHIR website. For a list of supported types, see the FhirResource constants, such as FHIR_RESOURCE_TYPE_IMMUNIZATION. Clients should be aware that this list is non exhaustive and may increase in future releases when additional types will need to be handled.
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|
Properties
CREATOR
static val CREATOR: Parcelable.Creator<FhirResource!>