Overview Package Class Tree Deprecated Index

All Superinterfaces:: HealthConstants.Common, HealthConstants.DiscreteMeasurement

Enclosing class:: HealthConstants

public static interface HealthConstants.HealthDocument
extends HealthConstants.DiscreteMeasurement

This interface defines health docuemnt data of the user.
This data type helps to handle the CDA and pdf health document.

Properties

Properties of the following extending interfaces are available for this data type.

Health document data has the following properties.
See more common properties by spreading this section out.

Property name	Description
HealthConstants.HealthDocument.UUID	[Mandatory] Data's unique ID, assigned by the system when a new data is inserted
HealthConstants.HealthDocument.CREATE_TIME	[Mandatory] UTC milliseconds when a data is created in the health data store, assigned by the system when a new data is inserted
HealthConstants.HealthDocument.UPDATE_TIME	[Mandatory] UTC milliseconds when a data is updated in the health data store, assigned by the system when a new data is inserted or the existing data is updated
HealthConstants.HealthDocument.PACKAGE_NAME	[Mandatory] Package name which provides data, assigned by the system when a new data is inserted
HealthConstants.HealthDocument.DEVICE_UUID	[Mandatory] Device identifier which provides the health data
HealthConstants.HealthDocument.START_TIME	[Mandatory] UTC milliseconds when the measurement is started
HealthConstants.HealthDocument.TIME_OFFSET	[Mandatory] Time offset in milliseconds which considers the time zone and daylight saving time
HealthConstants.HealthDocument.TYPE	[Mandatory] Document type
HealthConstants.HealthDocument.DOCUMENT	[Mandatory] Document file
HealthConstants.HealthDocument.ID	[Mandatory] Document ID
HealthConstants.HealthDocument.TITLE	[Mandatory] Document title
HealthConstants.HealthDocument.PATIENT	[Mandatory] Patient name
HealthConstants.HealthDocument.CUSTODIAN	[Mandatory] Custodian or hospital name that manages this document
HealthConstants.HealthDocument.PATIENT_GENDER	Gender code of patient
HealthConstants.HealthDocument.PATIENT_BIRTHDATE	Patient birth date with the `yyyymmdd` format
HealthConstants.HealthDocument.AUTHOR	Author or doctor name who write this document
HealthConstants.HealthDocument.CUSTOM	Custom info which is formatted with JSON and compressed data

Data Permission

The health document access is allowed with the instant permission. The instant permission can be gained with the following APIs.

HealthDataResolver.deleteWithPermission()

See acquring instant data permission.

Since:: 1.3.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTHOR` Author or doctor name who write this document.
`static String`	`CUSTODIAN` Custodian or hospital name that manages this document.
`static String`	`DOCUMENT` Document file.
`static String`	`HEALTH_DATA_TYPE` Data type name for Health Document.
`static String`	`ID` Document ID.
`static String`	`PATIENT` Patient name.
`static String`	`PATIENT_BIRTHDATE` Patient birth date with the `yyyymmdd` format.
`static String`	`PATIENT_GENDER` Gender code of the patient.
`static String`	`TITLE` Document title.
`static String`	`TYPE` Document type.
`static int`	`TYPE_CDA` CDA (HL7 Clinical Document Architecture) type.
`static int`	`TYPE_PDF` PDF (Portable Document Format) type.

Fields inherited from interface com.samsung.android.sdk.healthdata.HealthConstants.DiscreteMeasurement
START_TIME, TIME_OFFSET

Fields inherited from interface com.samsung.android.sdk.healthdata.HealthConstants.Common
CREATE_TIME, CUSTOM, DEVICE_UUID, PACKAGE_NAME, UPDATE_TIME, UUID

- Field Detail
  - TYPE
```
static final String TYPE
```
    Document type.
    - Mandatory
    - Type: int
    - Available values: one of the following values
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - TYPE_CDA
```
static final int TYPE_CDA
```
    CDA (HL7 Clinical Document Architecture) type.
    Its constant value is 1.
    
    Since:
    
    1.3.0
    
    See Also:
    
    TYPE, Constant Field Values
  - TYPE_PDF
```
static final int TYPE_PDF
```
    PDF (Portable Document Format) type.
    Its constant value is 2.
    
    Since:
    
    1.3.0
    
    See Also:
    
    TYPE, Constant Field Values
  - DOCUMENT
```
static final String DOCUMENT
```
    Document file.
    - Mandatory
    - Type: File
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - ID
```
static final String ID
```
    Document ID.
    - Mandatory
    - Type: String
    - Value length: 0 ~ 60
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - TITLE
```
static final String TITLE
```
    Document title.
    - Mandatory
    - Type: String
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
static final String PATIENT
```
    Patient name.
    - Mandatory
    - Type: String
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - PATIENT_GENDER
```
static final String PATIENT_GENDER
```
    Gender code of the patient.
    "M" indicates a male and "F" indicates a female.
    - Optional
    - Type: String
    - Value length: 0 ~ 1
    - Available values: one of the following values
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - PATIENT_BIRTHDATE
```
static final String PATIENT_BIRTHDATE
```
    Patient birth date with the yyyymmdd format.
    - Optional
    - Type: String
    - Value length: 0 ~ 8
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - AUTHOR
```
static final String AUTHOR
```
    Author or doctor name who write this document.
    - Optional
    - Type: String
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - CUSTODIAN
```
static final String CUSTODIAN
```
    Custodian or hospital name that manages this document.
    - Mandatory
    - Type: String
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - HEALTH_DATA_TYPE
```
static final String HEALTH_DATA_TYPE
```
    Data type name for Health Document.
    
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values

Interface HealthConstants.HealthDocument

Properties

Data Permission

Field Summary

Fields inherited from interface com.samsung.android.sdk.healthdata.HealthConstants.DiscreteMeasurement

Fields inherited from interface com.samsung.android.sdk.healthdata.HealthConstants.Common

Field Detail

TYPE

TYPE_CDA

TYPE_PDF

DOCUMENT

ID

TITLE

PATIENT

PATIENT_GENDER

PATIENT_BIRTHDATE

AUTHOR

CUSTODIAN

HEALTH_DATA_TYPE