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

FHIR IG Statistics: StructureDefinition/XON

Packagehl7.v2plus
Resource TypeStructureDefinition
IdXON
FHIR VersionR5
Sourcehttp://somewhere.org/fhir/uv/v2plus/https://build.fhir.org/ig/HL7/v2ig/StructureDefinition-XON.html
URLhttp://hl7.org/v2/StructureDefinition/XON
Version0.0.0
Statusactive
Date2025-07-11T16:45:01+00:00
NameXON
TitleHL7 v2 XON Data Type
Authorityhl7
DescriptionThis 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
Typehttp://hl7.org/v2/StructureDefinition/XON
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
CWEHL7 v2 CWE 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-0203hl7VS-identifierType
v2-0204hl7VS-organizationalNameType
v2-0465hl7VS-name-addressRepresentation

Narrative

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

Generated Narrative: StructureDefinition XON

NameFlagsCard.TypeDescription & Constraintsdoco
.. XON 0..*V2ComplexDataTypeextended composite name and identification number for organizations
... 1 0..1stringOrganization Name
... 2 0..1CWEOrganization Name Type Code
Binding: hl7VS-organizationalNameType (required)
... 3 ID Number
... 4 Identifier Check Digit
... 5 Check Digit Scheme
... 6 0..1HDAssigning Authority
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)
... 7 0..1codeIdentifier Type Code
Binding: hl7VS-identifierType (required)
... 8 0..1HDAssigning Facility
... 9 0..1codeName Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 10 0..1stringOrganization Identifier

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "XON",
  "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/XON",
  "version": "0.0.0",
  "name": "XON",
  "title": "HL7 v2 XON 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": "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.\n\nExample 1:\n\nThe 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.\n\nGood Health Hospital^L^716^9^M10^&Hospital Master.Community Health and Hospitals&L^XX^&Central Offices.Community Health and Hospitals&L^A\n\nExample 2:\n\nGood 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:\n\nGood Health Hospital^L^4544^3^M10^CMS^XX^^A",
  "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/XON",
  "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": "XON",
        "path": "XON",
        "short": "extended composite name and identification number for organizations",
        "definition": "Base definition for all types defined in FHIR type system.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "XON.1",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "length",
                "valueInteger": 50
              },
              {
                "url": "noTruncate",
                "valueBoolean": true
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/conformance-length"
          }
        ],
        "path": "XON.1",
        "short": "Organization Name",
        "min": 0,
        "max": "1",
        "base": {
          "path": "XON.1",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ST"
          }
        ]
      },
      {
        "id": "XON.2",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "XON.2",
        "short": "Organization Name Type Code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "XON.2",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/CWE"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0204"
        }
      },
      {
        "id": "XON.3",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "W"
          }
        ],
        "path": "XON.3",
        "short": "ID Number",
        "base": {
          "path": "XON.3",
          "min": 0
        }
      },
      {
        "id": "XON.4",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "W"
          }
        ],
        "path": "XON.4",
        "short": "Identifier Check Digit",
        "base": {
          "path": "XON.4",
          "min": 0
        }
      },
      {
        "id": "XON.5",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "W"
          }
        ],
        "path": "XON.5",
        "short": "Check Digit Scheme",
        "base": {
          "path": "XON.5",
          "min": 0
        }
      },
      {
        "id": "XON.6",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "XON.6",
        "short": "Assigning Authority",
        "min": 0,
        "max": "1",
        "base": {
          "path": "XON.6",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0363"
        }
      },
      {
        "id": "XON.7",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "min",
                "valueInteger": 2
              },
              {
                "url": "max",
                "valueInteger": 5
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/length"
          }
        ],
        "path": "XON.7",
        "short": "Identifier Type Code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "XON.7",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ID"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0203"
        }
      },
      {
        "id": "XON.8",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "XON.8",
        "short": "Assigning Facility",
        "min": 0,
        "max": "1",
        "base": {
          "path": "XON.8",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ]
      },
      {
        "id": "XON.9",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "min",
                "valueInteger": 1
              },
              {
                "url": "max",
                "valueInteger": 1
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/length"
          }
        ],
        "path": "XON.9",
        "short": "Name Representation Code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "XON.9",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ID"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0465"
        }
      },
      {
        "id": "XON.10",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "XON.10",
        "short": "Organization Identifier",
        "min": 0,
        "max": "1",
        "base": {
          "path": "XON.10",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ST"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "XON",
        "path": "XON",
        "short": "extended composite name and identification number for organizations",
        "min": 0,
        "max": "*"
      },
      {
        "id": "XON.1",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "length",
                "valueInteger": 50
              },
              {
                "url": "noTruncate",
                "valueBoolean": true
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/conformance-length"
          }
        ],
        "path": "XON.1",
        "short": "Organization Name",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ST"
          }
        ]
      },
      {
        "id": "XON.2",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "XON.2",
        "short": "Organization Name Type Code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/CWE"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0204"
        }
      },
      {
        "id": "XON.3",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "W"
          }
        ],
        "path": "XON.3",
        "short": "ID Number"
      },
      {
        "id": "XON.4",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "W"
          }
        ],
        "path": "XON.4",
        "short": "Identifier Check Digit"
      },
      {
        "id": "XON.5",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "W"
          }
        ],
        "path": "XON.5",
        "short": "Check Digit Scheme"
      },
      {
        "id": "XON.6",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "XON.6",
        "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": "XON.7",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "min",
                "valueInteger": 2
              },
              {
                "url": "max",
                "valueInteger": 5
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/length"
          }
        ],
        "path": "XON.7",
        "short": "Identifier Type Code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ID"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0203"
        }
      },
      {
        "id": "XON.8",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "XON.8",
        "short": "Assigning Facility",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ]
      },
      {
        "id": "XON.9",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "min",
                "valueInteger": 1
              },
              {
                "url": "max",
                "valueInteger": 1
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/length"
          }
        ],
        "path": "XON.9",
        "short": "Name Representation Code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ID"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0465"
        }
      },
      {
        "id": "XON.10",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "XON.10",
        "short": "Organization Identifier",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ST"
          }
        ]
      }
    ]
  }
}