Package | hl7.v2plus |
Type | StructureDefinition |
Id | CX |
FHIR Version | R5 |
Source | http://somewhere.org/fhir/uv/v2plus/https://build.fhir.org/ig/HL7/v2ig/StructureDefinition-CX.html |
URL | http://hl7.org/v2/StructureDefinition/CX |
Version | 0.0.0 |
Status | active |
Date | 2025-07-11T16:45:01+00:00 |
Name | CX |
Title | HL7 v2 CX Data Type |
Authority | hl7 |
Description | *Note:* The check digit and check digit scheme are null if ID is alphanumeric. Example: |1234567^4^M11^ADT01^MR^University Hospital| |
Type | http://hl7.org/v2/StructureDefinition/CX |
Kind | logical |
No resources found
StructureDefinition | |
CWE | HL7 v2 CWE Data Type |
DT | HL7 v2 DT Data Type |
HD | HL7 v2 HD Data Type |
ID | HL7 v2 ID Data Type |
ST | HL7 v2 String Primitive Type |
complex-data-type | HL7 v2 Complex Data Type |
ValueSet | |
v2-0061 | hl7VS-checkDigitScheme |
v2-0203 | hl7VS-identifierType |
v2-0904 | hl7VS-securityCheckScheme |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition CX
Profile: HL7 v2 Complex Data Type Profile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
![]() ![]() | 0..* | V2ComplexDataType | extended composite ID with check digit | |
![]() ![]() ![]() | 1..1 | string | ID Number | |
![]() ![]() ![]() | 0..1 | string | Identifier Check Digit | |
![]() ![]() ![]() | 0..1 | code | Check Digit Scheme Binding: hl7VS-checkDigitScheme (required) | |
![]() ![]() ![]() | 0..1 | HD | Assigning Authority Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required) | |
![]() ![]() ![]() | 1..1 | code | Identifier Type Code Binding: hl7VS-identifierType (required) | |
![]() ![]() ![]() | 0..1 | HD | Assigning Facility | |
![]() ![]() ![]() | 0..1 | date | Effective Date | |
![]() ![]() ![]() | 0..1 | date | Expiration Date | |
![]() ![]() ![]() | 0..1 | CWE | Assigning Jurisdiction | |
![]() ![]() ![]() | 0..1 | CWE | Assigning Agency or Department | |
![]() ![]() ![]() | 0..1 | string | Security Check | |
![]() ![]() ![]() | 0..1 | code | Security Check Scheme Binding: hl7VS-securityCheckScheme (required) | |
{ "resourceType": "StructureDefinition", "id": "CX", "meta": { "profile": [ "http://hl7.org/v2/StructureDefinition/complex-data-type-profile" ] }, "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "informative", "_valueCode": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://somewhere.org/fhir/uv/v2plus/ImplementationGuide/hl7.other.uv.v2plus" } ] } } ], "url": "http://hl7.org/v2/StructureDefinition/CX", "version": "0.0.0", "name": "CX", "title": "HL7 v2 CX Data Type", "status": "active", "date": "2025-07-11T16:45:01+00:00", "publisher": "HL7 International", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/Special/committees/v2mgmt" } ] } ], "description": "*Note:* The check digit and check digit scheme are null if ID is alphanumeric.\n\nExample:\n\n|1234567^4^M11^ADT01^MR^University Hospital|", "fhirVersion": "5.0.0", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "logical", "abstract": false, "type": "http://hl7.org/v2/StructureDefinition/CX", "baseDefinition": "http://hl7.org/v2/StructureDefinition/complex-data-type", "derivation": "specialization", "snapshot": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "0.0.0" } ], "element": [ { "id": "CX", "path": "CX", "short": "extended composite ID with check digit", "definition": "Definition: This data type is used for specifying an identifier with its associated administrative detail.", "min": 0, "max": "*", "base": { "path": "Base", "min": 0, "max": "*" }, "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CX.1", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "R" }, { "extension": [ { "url": "length", "valueInteger": 15 }, { "url": "noTruncate", "valueBoolean": true } ], "url": "http://hl7.org/v2/StructureDefinition/conformance-length" } ], "path": "CX.1", "short": "ID Number", "min": 1, "max": "1", "base": { "path": "CX.1", "min": 1, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ST" } ] }, { "id": "CX.2", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" }, { "extension": [ { "url": "length", "valueInteger": 4 }, { "url": "noTruncate", "valueBoolean": true } ], "url": "http://hl7.org/v2/StructureDefinition/conformance-length" } ], "path": "CX.2", "short": "Identifier Check Digit", "min": 0, "max": "1", "base": { "path": "CX.2", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ST" } ] }, { "id": "CX.3", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" }, { "extension": [ { "url": "min", "valueInteger": 3 }, { "url": "max", "valueInteger": 3 } ], "url": "http://hl7.org/v2/StructureDefinition/length" } ], "path": "CX.3", "short": "Check Digit Scheme", "min": 0, "max": "1", "base": { "path": "CX.3", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ID" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0061" } }, { "id": "CX.4", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "C" } ], "path": "CX.4", "short": "Assigning Authority", "min": 0, "max": "1", "base": { "path": "CX.4", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/HD" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0363" } }, { "id": "CX.5", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "R" }, { "extension": [ { "url": "min", "valueInteger": 2 }, { "url": "max", "valueInteger": 5 } ], "url": "http://hl7.org/v2/StructureDefinition/length" } ], "path": "CX.5", "short": "Identifier Type Code", "min": 1, "max": "1", "base": { "path": "CX.5", "min": 1, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ID" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0203" } }, { "id": "CX.6", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" } ], "path": "CX.6", "short": "Assigning Facility", "min": 0, "max": "1", "base": { "path": "CX.6", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/HD" } ] }, { "id": "CX.7", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" } ], "path": "CX.7", "short": "Effective Date", "min": 0, "max": "1", "base": { "path": "CX.7", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/DT" } ] }, { "id": "CX.8", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" } ], "path": "CX.8", "short": "Expiration Date", "min": 0, "max": "1", "base": { "path": "CX.8", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/DT" } ] }, { "id": "CX.9", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "C" } ], "path": "CX.9", "short": "Assigning Jurisdiction", "min": 0, "max": "1", "base": { "path": "CX.9", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/CWE" } ] }, { "id": "CX.10", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "C" } ], "path": "CX.10", "short": "Assigning Agency or Department", "min": 0, "max": "1", "base": { "path": "CX.10", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/CWE" } ] }, { "id": "CX.11", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" }, { "extension": [ { "url": "length", "valueInteger": 4 }, { "url": "noTruncate", "valueBoolean": true } ], "url": "http://hl7.org/v2/StructureDefinition/conformance-length" } ], "path": "CX.11", "short": "Security Check", "min": 0, "max": "1", "base": { "path": "CX.11", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ST" } ] }, { "id": "CX.12", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" }, { "extension": [ { "url": "min", "valueInteger": 3 }, { "url": "max", "valueInteger": 3 } ], "url": "http://hl7.org/v2/StructureDefinition/length" } ], "path": "CX.12", "short": "Security Check Scheme", "min": 0, "max": "1", "base": { "path": "CX.12", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ID" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0904" } } ] }, "differential": { "element": [ { "id": "CX", "path": "CX", "short": "extended composite ID with check digit", "definition": "Definition: This data type is used for specifying an identifier with its associated administrative detail.", "min": 0, "max": "*" }, { "id": "CX.1", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "R" }, { "extension": [ { "url": "length", "valueInteger": 15 }, { "url": "noTruncate", "valueBoolean": true } ], "url": "http://hl7.org/v2/StructureDefinition/conformance-length" } ], "path": "CX.1", "short": "ID Number", "min": 1, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ST" } ] }, { "id": "CX.2", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" }, { "extension": [ { "url": "length", "valueInteger": 4 }, { "url": "noTruncate", "valueBoolean": true } ], "url": "http://hl7.org/v2/StructureDefinition/conformance-length" } ], "path": "CX.2", "short": "Identifier Check Digit", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ST" } ] }, { "id": "CX.3", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" }, { "extension": [ { "url": "min", "valueInteger": 3 }, { "url": "max", "valueInteger": 3 } ], "url": "http://hl7.org/v2/StructureDefinition/length" } ], "path": "CX.3", "short": "Check Digit Scheme", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ID" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0061" } }, { "id": "CX.4", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "C" } ], "path": "CX.4", "short": "Assigning Authority", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/HD" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0363" } }, { "id": "CX.5", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "R" }, { "extension": [ { "url": "min", "valueInteger": 2 }, { "url": "max", "valueInteger": 5 } ], "url": "http://hl7.org/v2/StructureDefinition/length" } ], "path": "CX.5", "short": "Identifier Type Code", "min": 1, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ID" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0203" } }, { "id": "CX.6", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" } ], "path": "CX.6", "short": "Assigning Facility", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/HD" } ] }, { "id": "CX.7", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" } ], "path": "CX.7", "short": "Effective Date", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/DT" } ] }, { "id": "CX.8", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" } ], "path": "CX.8", "short": "Expiration Date", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/DT" } ] }, { "id": "CX.9", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "C" } ], "path": "CX.9", "short": "Assigning Jurisdiction", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/CWE" } ] }, { "id": "CX.10", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "C" } ], "path": "CX.10", "short": "Assigning Agency or Department", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/CWE" } ] }, { "id": "CX.11", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" }, { "extension": [ { "url": "length", "valueInteger": 4 }, { "url": "noTruncate", "valueBoolean": true } ], "url": "http://hl7.org/v2/StructureDefinition/conformance-length" } ], "path": "CX.11", "short": "Security Check", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ST" } ] }, { "id": "CX.12", "extension": [ { "url": "http://hl7.org/v2/StructureDefinition/optionality", "valueCode": "O" }, { "extension": [ { "url": "min", "valueInteger": 3 }, { "url": "max", "valueInteger": 3 } ], "url": "http://hl7.org/v2/StructureDefinition/length" } ], "path": "CX.12", "short": "Security Check Scheme", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/v2/StructureDefinition/ID" } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0904" } } ] } }