ex_hl7 v0.3.0 HL7.Composite.XCN

2.9.52 XCN - extended composite ID number and name for persons

Components:

  • id_number (ST)
  • family_name (FN)
  • given_name (ST)
  • second_name (ST)
  • suffix (ST)
  • prefix (ST)
  • degree (IS)
  • source_table (IS)
  • assigning_authority (HD)
  • name_type_code (ID)
  • check_digit (ST)
  • check_digit_scheme (ID)
  • id_type (IS)
  • assigning_facility (HD)
  • name_representation_code (ID)
  • name_context (CE)
  • name_validity (DR)
  • name_assembly_order (ID)

Subcomponents of family_name:

  • surname (ST)
  • own_surname_prefix (ST)
  • own_surname (ST)
  • surname_prefix_from_partner (ST)
  • surname_from_partner (ST)

Subcomponents of assigning_authority:

  • namespace_id (IS)
  • universal_id (ST)
  • universal_id_type (ID)

Subcomponents of assigning_facility:

  • namespace_id (IS)
  • universal_id (ST)
  • universal_id_type (ID)

Subcomponents of name_context:

  • id (ST)
  • text (ST)
  • coding_system (IS)
  • alt_id (ST)
  • alt_text (ST)
  • alt_coding_system (IS)

Subcomponents of name_validity:

  • start_datetime (TS)
  • end_datetime (TS)

This data type is used extensively appearing in the PV1, ORC, RXO, RXE, OBR and SCH segments, as well as others, where there is a need to specify the ID number and name of a person.

Examples

Neither an assigning authority nor an assigning facility are present in the example:

|1234567^Smith^John^J^III^DR^PHD^ADT01^^L^4^M11^MR|

Summary

Functions

Create a new composite field

Types

t :: %HL7.Composite.XCN{assigning_authority: HL7.Composite.HD.t, assigning_facility: HL7.Composite.HD.t, check_digit: binary, check_digit_scheme: binary, degree: binary, family_name: binary, given_name: binary, id_number: binary, id_type: binary, name_assembly_order: binary, name_context: HL7.Composite.CE.t, name_representation_code: binary, name_type_code: binary, name_validity: HL7.Composite.DR.t, prefix: binary, second_name: binary, source_table: binary, suffix: binary}

Functions

new()

Specs

new :: t

Create a new composite field