Entity: Reference Datum & Coding Match

Class Diagram

Reference Datum & Coding Match

Display

Pre-defined customer reference sets are managed by the Organisation administrator, and represented as instances of [[Reference Datum]].

PKB-managed reference sets are managed by PKB and represented as instances of [[Coding Match]].

Please see the manual for more information.

Mappings

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

 

 

Summary of interactions

Create

 

 

 

 

 

Read

 

 

/ValueSet

Code sets

 

Update

 

 

 

 

 

Delete

 

 

 

 

 

Entity: Reference Set

Public ID String

 

 

 

 

 

Aggregated ID String

 

 

This is the resource id.

 

 

Type Enum

  • ORDER_SERVICE

  • HOSPITAL_SERVICE

  • UNIT

  • LAB_DISCIPLINE

 

 

Included in the url and compose.include.system elements.

 

 

Entity: Reference Datum

Legacy ID String

 

 

 

 

 

Public ID String

 

 

 

 

 

Value String

 

 

compose

 

 

Text String

 

 

compose

 

 

Privacy Label Enum

  • GENERAL_HEALTH

  • MENTAL_HEALTH

  • SEXUAL_HEALTH

  • SOCIAL_CARE

 

 

privacy-label

 

 

 

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

 

 

Summary of interactions

Create

 

 

 

 

 

Read

 

 

/ValueSet

 

 

Update

 

 

 

 

 

Delete

 

 

 

 

 

Entity: Coding Match

Legacy ID String

 

 

 

 

 

Public ID String

 

 

 

 

 

Aggregated ID String

 

 

This is the resource ID.

 

 

Type Enum

 

 

data-type

 

 

Exclude Boolean

 

 

sensitive-exclusion-code

 

 

Code String

 

 

compose

Also included in the url and compose.include.system elements.

 

 

System String

 

 

Included in the url and compose.include.system elements.

 

 

Text String

 

 

compose

 

 

Privacy Label Enum

  • GENERAL_HEALTH

  • MENTAL_HEALTH

  • SEXUAL_HEALTH

  • SOCIAL_CARE

 

 

privacy-label

 

 

Parent Ref: [[Coding Match.Legacy ID]]

 

 

 

 

 

Created Timestamp

 

 

 

 

Â