HL7 v2+ Specification
0.0.0 - draft
HL7 v2+ Specification
0.0.0 - draft
HL7 v2+ Specification, published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/v2/StructureDefinition/XON | Version: 0.0.0 | |||
| Standards status: Informative | Computable Name: XON | |||
This data type is used in fields (e.g., PV2-23, NK1-13, PD1-3, OBR-44) to specify the name and ID number of an organization.
Example 1:
The ID for Good Health Hospital was assigned by the Community Health and Hospitals enterprise’s Hospital Master and was first issued at the Central Offices.
Good Health Hospital^L^716^9^M10^&Hospital Master.Community Health and Hospitals&L^XX^&Central Offices.Community Health and Hospitals&L^A
Example 2:
Good Health Hospital has another ID that was issued by CMS. Assigning Authority, CMS, values only the first HD component, an IS data type and assigning facility is not relevant. This information might be transmitted accordingly:
Good Health Hospital^L^4544^3^M10^CMS^XX^^A
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from V2ComplexDataType
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  XON |
0..* | V2ComplexDataType | extended composite name and identification number for organizations Instances of this logical model are not marked to be the target of a Reference | |
  1 |
0..1 | string | Organization Name | |
 2 |
0..1 | CWE | Organization Name Type Code Binding: hl7VS-organizationalNameType (required) | |
| 3 |
ID Number | |||
| 4 |
Identifier Check Digit | |||
| 5 |
Check Digit Scheme | |||
| 6 |
0..1 | HD | Assigning Authority Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required) | |
| 7 |
0..1 | code | Identifier Type Code Binding: hl7VS-identifierType (required) | |
| 8 |
0..1 | HD | Assigning Facility | |
| 9 |
0..1 | code | Name Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
 10 |
0..1 | string | Organization Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XON.2 | required | Hl7VSOrganizationalNameTypehttp://terminology.hl7.org/ValueSet/v2-0204 | |
| XON.6 | required | http://terminology.hl7.org/ValueSet/v2-0363http://terminology.hl7.org/ValueSet/v2-0363 | |
| XON.7 | required | Hl7VSIdentifierTypehttp://terminology.hl7.org/ValueSet/v2-0203 | |
| XON.9 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XON |
0..* | V2ComplexDataType | extended composite name and identification number for organizations Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | string | Organization Name | |
| 2 |
0..1 | CWE | Organization Name Type Code Binding: hl7VS-organizationalNameType (required) | |
| 3 |
ID Number | |||
| 4 |
Identifier Check Digit | |||
| 5 |
Check Digit Scheme | |||
| 6 |
0..1 | HD | Assigning Authority Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required) | |
| 7 |
0..1 | code | Identifier Type Code Binding: hl7VS-identifierType (required) | |
| 8 |
0..1 | HD | Assigning Facility | |
| 9 |
0..1 | code | Name Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 10 |
0..1 | string | Organization Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XON.2 | required | Hl7VSOrganizationalNameTypehttp://terminology.hl7.org/ValueSet/v2-0204 | |
| XON.6 | required | http://terminology.hl7.org/ValueSet/v2-0363http://terminology.hl7.org/ValueSet/v2-0363 | |
| XON.7 | required | Hl7VSIdentifierTypehttp://terminology.hl7.org/ValueSet/v2-0203 | |
| XON.9 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XON |
0..* | V2ComplexDataType | extended composite name and identification number for organizations Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | string | Organization Name | |
| 2 |
0..1 | CWE | Organization Name Type Code Binding: hl7VS-organizationalNameType (required) | |
| 3 |
ID Number | |||
| 4 |
Identifier Check Digit | |||
| 5 |
Check Digit Scheme | |||
| 6 |
0..1 | HD | Assigning Authority Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required) | |
| 7 |
0..1 | code | Identifier Type Code Binding: hl7VS-identifierType (required) | |
| 8 |
0..1 | HD | Assigning Facility | |
| 9 |
0..1 | code | Name Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 10 |
0..1 | string | Organization Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XON.2 | required | Hl7VSOrganizationalNameTypehttp://terminology.hl7.org/ValueSet/v2-0204 | |
| XON.6 | required | http://terminology.hl7.org/ValueSet/v2-0363http://terminology.hl7.org/ValueSet/v2-0363 | |
| XON.7 | required | Hl7VSIdentifierTypehttp://terminology.hl7.org/ValueSet/v2-0203 | |
| XON.9 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 |
This structure is derived from V2ComplexDataType
Differential View
This structure is derived from V2ComplexDataType
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XON |
0..* | V2ComplexDataType | extended composite name and identification number for organizations Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | string | Organization Name | |
| 2 |
0..1 | CWE | Organization Name Type Code Binding: hl7VS-organizationalNameType (required) | |
| 3 |
ID Number | |||
| 4 |
Identifier Check Digit | |||
| 5 |
Check Digit Scheme | |||
| 6 |
0..1 | HD | Assigning Authority Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required) | |
| 7 |
0..1 | code | Identifier Type Code Binding: hl7VS-identifierType (required) | |
| 8 |
0..1 | HD | Assigning Facility | |
| 9 |
0..1 | code | Name Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 10 |
0..1 | string | Organization Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XON.2 | required | Hl7VSOrganizationalNameTypehttp://terminology.hl7.org/ValueSet/v2-0204 | |
| XON.6 | required | http://terminology.hl7.org/ValueSet/v2-0363http://terminology.hl7.org/ValueSet/v2-0363 | |
| XON.7 | required | Hl7VSIdentifierTypehttp://terminology.hl7.org/ValueSet/v2-0203 | |
| XON.9 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XON |
0..* | V2ComplexDataType | extended composite name and identification number for organizations Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | string | Organization Name | |
| 2 |
0..1 | CWE | Organization Name Type Code Binding: hl7VS-organizationalNameType (required) | |
| 3 |
ID Number | |||
| 4 |
Identifier Check Digit | |||
| 5 |
Check Digit Scheme | |||
| 6 |
0..1 | HD | Assigning Authority Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required) | |
| 7 |
0..1 | code | Identifier Type Code Binding: hl7VS-identifierType (required) | |
| 8 |
0..1 | HD | Assigning Facility | |
| 9 |
0..1 | code | Name Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 10 |
0..1 | string | Organization Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XON.2 | required | Hl7VSOrganizationalNameTypehttp://terminology.hl7.org/ValueSet/v2-0204 | |
| XON.6 | required | http://terminology.hl7.org/ValueSet/v2-0363http://terminology.hl7.org/ValueSet/v2-0363 | |
| XON.7 | required | Hl7VSIdentifierTypehttp://terminology.hl7.org/ValueSet/v2-0203 | |
| XON.9 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| XON |
0..* | V2ComplexDataType | extended composite name and identification number for organizations Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
0..1 | string | Organization Name | |
| 2 |
0..1 | CWE | Organization Name Type Code Binding: hl7VS-organizationalNameType (required) | |
| 3 |
ID Number | |||
| 4 |
Identifier Check Digit | |||
| 5 |
Check Digit Scheme | |||
| 6 |
0..1 | HD | Assigning Authority Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required) | |
| 7 |
0..1 | code | Identifier Type Code Binding: hl7VS-identifierType (required) | |
| 8 |
0..1 | HD | Assigning Facility | |
| 9 |
0..1 | code | Name Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 10 |
0..1 | string | Organization Identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| XON.2 | required | Hl7VSOrganizationalNameTypehttp://terminology.hl7.org/ValueSet/v2-0204 | |
| XON.6 | required | http://terminology.hl7.org/ValueSet/v2-0363http://terminology.hl7.org/ValueSet/v2-0363 | |
| XON.7 | required | Hl7VSIdentifierTypehttp://terminology.hl7.org/ValueSet/v2-0203 | |
| XON.9 | required | Hl7VSNameAddressRepresentationhttp://terminology.hl7.org/ValueSet/v2-0465 |
This structure is derived from V2ComplexDataType