Added in Android Baklava

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

MedicalResourceId

---

Kotlin |Java

public final class MedicalResourceId
extends Object implements Parcelable

java.lang.Object
↳	android.health.connect.MedicalResourceId

---

A class to represent a unique identifier of a medical resource.

This class contains a set of properties that together represent a unique identifier of a medical resource.

The medical resource data representation follows the Fast Healthcare Interoperability Resources (FHIR) standard.

Summary

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<MedicalResourceId>	CREATOR

Public constructors
MedicalResourceId(String dataSourceId, int fhirResourceType, String fhirResourceId) Constructs a new MedicalResourceId instance.

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
static MedicalResourceId	fromFhirReference(String dataSourceId, String fhirReference) Creates a MedicalResourceId instance from dataSourceId and fhirReference.
String	getDataSourceId() Returns the unique MedicalDataSource ID of where the data comes from.
String	getFhirResourceId() Returns the FHIR resource ID.
int	getFhirResourceType() Returns the FHIR resource type.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in Android Baklava

public static final Creator<MedicalResourceId> CREATOR

Public constructors

MedicalResourceId

Added in Android Baklava

public MedicalResourceId (String dataSourceId, 
                int fhirResourceType, 
                String fhirResourceId)

Constructs a new MedicalResourceId instance.

Parameters
dataSourceId	String: The unique identifier of the existing MedicalDataSource, representing where the data comes from. This value cannot be null.
fhirResourceType	int: The FHIR resource type. This is the "resourceType" field from a JSON representation of FHIR resource data. Value is FhirResource.FHIR_RESOURCE_TYPE_IMMUNIZATION, FhirResource.FHIR_RESOURCE_TYPE_ALLERGY_INTOLERANCE, FhirResource.FHIR_RESOURCE_TYPE_OBSERVATION, FhirResource.FHIR_RESOURCE_TYPE_CONDITION, FhirResource.FHIR_RESOURCE_TYPE_PROCEDURE, FhirResource.FHIR_RESOURCE_TYPE_MEDICATION, FhirResource.FHIR_RESOURCE_TYPE_MEDICATION_REQUEST, FhirResource.FHIR_RESOURCE_TYPE_MEDICATION_STATEMENT, FhirResource.FHIR_RESOURCE_TYPE_PATIENT, FhirResource.FHIR_RESOURCE_TYPE_PRACTITIONER, FhirResource.FHIR_RESOURCE_TYPE_PRACTITIONER_ROLE, FhirResource.FHIR_RESOURCE_TYPE_ENCOUNTER, FhirResource.FHIR_RESOURCE_TYPE_LOCATION, or FhirResource.FHIR_RESOURCE_TYPE_ORGANIZATION
fhirResourceId	String: The FHIR resource ID. This is the "id" field from a JSON representation of FHIR resource data. This value cannot be null.

Throws
IllegalArgumentException	if the provided dataSourceId is not a valid ID, or fhirResourceType is not a valid supported type.

Public methods

describeContents

Added in Android Baklava

public int describeContents ()

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.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in Android Baklava

public boolean equals (Object o)

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 return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

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
o	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

fromFhirReference

Added in Android Baklava

public static MedicalResourceId fromFhirReference (String dataSourceId, 
                String fhirReference)

Creates a MedicalResourceId instance from dataSourceId and fhirReference.

Parameters
dataSourceId	String: The unique identifier of the existing MedicalDataSource, representing where the data comes from. This value cannot be null.
fhirReference	String: The FHIR reference string typically extracted from the "reference" field in one FHIR resource (source), pointing to another FHIR resource (target) within the same data source, for example "Patient/034AB16". This value cannot be null.

Returns
MedicalResourceId	This value cannot be null.

Throws

IllegalArgumentException

if the provided dataSourceId is not a valid ID, the referenced resource type is not a valid FhirResource type supported by Health Connect, or fhirReference does not match with the pattern of $fhir_resource_type/$fhir_resource_id, where the FHIR resource type should align with the resource list in the official FHIR website, and the FHIR resource ID should also follow the pattern described in the official FHIR datatypes.

getDataSourceId

Added in Android Baklava

public String getDataSourceId ()

Returns the unique MedicalDataSource ID of where the data comes from.

Returns
String	This value cannot be null.

getFhirResourceId

Added in Android Baklava

public String getFhirResourceId ()

Returns the FHIR resource ID.

Returns
String	This value cannot be null.

getFhirResourceType

Added in Android Baklava

public int getFhirResourceType ()

Returns the FHIR resource type.

Returns

int

Value is FhirResource.FHIR_RESOURCE_TYPE_IMMUNIZATION, FhirResource.FHIR_RESOURCE_TYPE_ALLERGY_INTOLERANCE, FhirResource.FHIR_RESOURCE_TYPE_OBSERVATION, FhirResource.FHIR_RESOURCE_TYPE_CONDITION, FhirResource.FHIR_RESOURCE_TYPE_PROCEDURE, FhirResource.FHIR_RESOURCE_TYPE_MEDICATION, FhirResource.FHIR_RESOURCE_TYPE_MEDICATION_REQUEST, FhirResource.FHIR_RESOURCE_TYPE_MEDICATION_STATEMENT, FhirResource.FHIR_RESOURCE_TYPE_PATIENT, FhirResource.FHIR_RESOURCE_TYPE_PRACTITIONER, FhirResource.FHIR_RESOURCE_TYPE_PRACTITIONER_ROLE, FhirResource.FHIR_RESOURCE_TYPE_ENCOUNTER, FhirResource.FHIR_RESOURCE_TYPE_LOCATION, or FhirResource.FHIR_RESOURCE_TYPE_ORGANIZATION

hashCode

Added in Android Baklava

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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.

Returns
int	a hash code value for this object.

toString

Added in Android Baklava

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in Android Baklava

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES