Added in API level 36
Also in U Extensions 16

MedicalResourceId

class MedicalResourceId : Parcelable
kotlin.Any
   ↳ 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
Public constructors
MedicalResourceId(dataSourceId: String, fhirResourceType: Int, fhirResourceId: String)

Constructs a new MedicalResourceId instance.
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
static MedicalResourceId
fromFhirReference(dataSourceId: String, fhirReference: String)

Creates a MedicalResourceId instance from dataSourceId and fhirReference.
String

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

Returns the FHIR resource ID.
Int

Returns the FHIR resource type.
Int

Returns a hash code value for the object.
String

Returns a string representation of the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<MedicalResourceId!>

Public constructors

MedicalResourceId

Added in API level 36
Also in U Extensions 16
MedicalResourceId(
    dataSourceId: String, 
    fhirResourceType: Int, 
    fhirResourceId: String)

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 one of the following:
fhirResourceId String: The FHIR resource ID. This is the "id" field from a JSON representation of FHIR resource data.
This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the provided dataSourceId is not a valid ID, or fhirResourceType is not a valid supported type.

Public methods

describeContents

Added in API level 36
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

Added in API level 36
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 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
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

fromFhirReference

Added in API level 36
Also in U Extensions 16
static fun fromFhirReference(
    dataSourceId: String, 
    fhirReference: String
): MedicalResourceId

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.
Return
MedicalResourceId This value cannot be null.
Exceptions
java.lang.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 API level 36
Also in U Extensions 16
fun getDataSourceId(): String

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

Return
String This value cannot be null.

getFhirResourceId

Added in API level 36
Also in U Extensions 16
fun getFhirResourceId(): String

Returns the FHIR resource ID.

Return
String This value cannot be null.

getFhirResourceType

Added in API level 36
Also in U Extensions 16
fun getFhirResourceType(): Int

Returns the FHIR resource type.

Return
Int Value is one of the following:

hashCode

Added in API level 36
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 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.
Return
Int a hash code value for this object.

toString

Added in API level 36
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 36
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

Added in API level 36
Also in U Extensions 16
static val CREATOR: Parcelable.Creator<MedicalResourceId!>