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

FHIR IG Statistics: StructureDefinition/2.16.840.1.113883.10.20.22.5.1.1

Packagehl7.cda.us.ccdar2dot2
TypeStructureDefinition
Id2.16.840.1.113883.10.20.22.5.1.1
FHIR VersionR4
Sourcehttp://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda-2.2/StructureDefinition-2.16.840.1.113883.10.20.22.5.1.1.html
URLhttp://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1.1
Version2.2
Statusactive
Date2022-05-13T15:50:12+00:00
NameUSRealmPersonNamePNUSFIELDED
TitleUS Realm Person Name (PN.US.FIELDED)
Realmus
Authorityhl7
DescriptionThe US Realm Clinical Document Person Name datatype flavor is a set of reusable constraints that can be used for Persons.
TypePN
Kindresource

Resources that use this resource

StructureDefinition
2.16.840.1.113883.10.20.22.1.1US Realm Header
2.16.840.1.113883.10.20.22.1.14Referral Note
2.16.840.1.113883.10.20.22.1.15Care Plan
2.16.840.1.113883.10.20.22.1.5Diagnostic Imaging Report
2.16.840.1.113883.10.20.22.4.123Drug Monitoring Act
2.16.840.1.113883.10.20.22.4.48Advance Directive Observation
2.16.840.1.113883.10.20.6.2.2Physician of Record Participant

Resources that this resource uses

No resources found


Narrative

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN I1..*PN81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "2.16.840.1.113883.10.20.22.5.1.1",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1.1",
  "identifier": [
    {
      "value": "urn:oid:2.16.840.1.113883.10.20.22.5.1.1"
    }
  ],
  "version": "2.2",
  "name": "USRealmPersonNamePNUSFIELDED",
  "title": "US Realm Person Name (PN.US.FIELDED)",
  "status": "active",
  "date": "2022-05-13T15:50:12+00:00",
  "publisher": "Health Level Seven",
  "contact": [
    {
      "name": "HL7 International - Structured Documents",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/structure"
        }
      ]
    }
  ],
  "description": "The US Realm Clinical Document Person Name datatype flavor is a set of reusable constraints that can be used for Persons.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "PN",
  "baseDefinition": "http://hl7.org/fhir/cda/StructureDefinition/PN",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "PN",
        "path": "PN",
        "definition": "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
        "min": 1,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "81-9371",
            "severity": "error",
            "human": "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371)."
          },
          {
            "key": "81-9372",
            "severity": "error",
            "human": "The string **SHALL NOT** contain name parts (CONF:81-9372)."
          }
        ],
        "isModifier": false
      },
      {
        "id": "PN.nullFlavor",
        "path": "PN.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ANY.nullFlavor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "id": "PN.use",
        "path": "PN.use",
        "representation": [
          "xmlAttr"
        ],
        "label": "Use Code",
        "definition": "A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EN.use",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-PersonNameUse"
        }
      },
      {
        "id": "PN.delimiter",
        "path": "PN.delimiter",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.delimiter",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.family",
        "path": "PN.family",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.family",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.given",
        "path": "PN.given",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.given",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.prefix",
        "path": "PN.prefix",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.prefix",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.suffix",
        "path": "PN.suffix",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.suffix",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.other",
        "path": "PN.other",
        "representation": [
          "xmlText"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "EN.other",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "PN.validTime",
        "path": "PN.validTime",
        "label": "Valid Time",
        "definition": "An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EN.validTime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "PN",
        "path": "PN",
        "constraint": [
          {
            "key": "81-9371",
            "severity": "error",
            "human": "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371)."
          },
          {
            "key": "81-9372",
            "severity": "error",
            "human": "The string **SHALL NOT** contain name parts (CONF:81-9372)."
          }
        ]
      }
    ]
  }
}