FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/CX

Packagehl7.v2plus
TypeStructureDefinition
IdCX
FHIR VersionR5
Sourcehttp://somewhere.org/fhir/uv/v2plus/https://build.fhir.org/ig/HL7/v2ig/StructureDefinition-CX.html
URLhttp://hl7.org/v2/StructureDefinition/CX
Version0.0.0
Statusactive
Date2025-07-11T16:45:01+00:00
NameCX
TitleHL7 v2 CX Data Type
Authorityhl7
Description*Note:* The check digit and check digit scheme are null if ID is alphanumeric. Example: |1234567^4^M11^ADT01^MR^University Hospital|
Typehttp://hl7.org/v2/StructureDefinition/CX
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
CWEHL7 v2 CWE Data Type
DTHL7 v2 DT Data Type
HDHL7 v2 HD Data Type
IDHL7 v2 ID Data Type
STHL7 v2 String Primitive Type
complex-data-typeHL7 v2 Complex Data Type
ValueSet
v2-0061hl7VS-checkDigitScheme
v2-0203hl7VS-identifierType
v2-0904hl7VS-securityCheckScheme

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition CX

NameFlagsCard.TypeDescription & Constraintsdoco
.. CX 0..*V2ComplexDataTypeextended composite ID with check digit
... 1 1..1stringID Number
... 2 0..1stringIdentifier Check Digit
... 3 0..1codeCheck Digit Scheme
Binding: hl7VS-checkDigitScheme (required)
... 4 0..1HDAssigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 5 1..1codeIdentifier Type Code
Binding: hl7VS-identifierType (required)
... 6 0..1HDAssigning Facility
... 7 0..1dateEffective Date
... 8 0..1dateExpiration Date
... 9 0..1CWEAssigning Jurisdiction
... 10 0..1CWEAssigning Agency or Department
... 11 0..1stringSecurity Check
... 12 0..1codeSecurity Check Scheme
Binding: hl7VS-securityCheckScheme (required)

doco Documentation for this format

Source

{
  "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"
        }
      }
    ]
  }
}