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

FHIR IG Statistics: StructureDefinition/PL

Packagehl7.v2plus
Resource TypeStructureDefinition
IdPL
FHIR VersionR5
Sourcehttp://somewhere.org/fhir/uv/v2plus/https://build.fhir.org/ig/HL7/v2ig/StructureDefinition-PL.html
URLhttp://hl7.org/v2/StructureDefinition/PL
Version0.0.0
Statusactive
Date2025-07-11T16:45:01+00:00
NamePL
TitleHL7 v2 PL Data Type
Authorityhl7
Description*Note:* This data type contains several location identifiers that should be thought of in the following order from the most general to the most specific: facility, building, floor, point of care, room, bed. + Additional data about any location defined by these components can be added in the following components: person location type, location description and location status. Example: Nursing Unit A nursing unit at Community Hospital: 4 East, room 136, bed B 4E^136^B^CommunityHospital^^N^^^ Example: Clinic A clinic at University Hospitals: Internal Medicine Clinic located in the Briones building, 3^rd^ floor. InternalMedicine^^^UniversityHospitals^^C^Briones^3^ Example: Home The patient was treated at his home. ^^^^^H^^^
Typehttp://hl7.org/v2/StructureDefinition/PL
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
EIHL7 v2 EI Data Type
HDHL7 v2 HD Data Type
ISHL7 v2 IS Data Type
STHL7 v2 String Primitive Type
complex-data-typeHL7 v2 Complex Data Type
ValueSet
v2-0305hl7VS-personLocationType

Narrative

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

Generated Narrative: StructureDefinition PL

NameFlagsCard.TypeDescription & Constraintsdoco
.. PL 0..*V2ComplexDataTypeperson location
... 1 0..1HDPoint of Care
Binding: http://terminology.hl7.org/ValueSet/v2-0302 (required)
... 2 0..1HDRoom
Binding: http://terminology.hl7.org/ValueSet/v2-0303 (required)
... 3 0..1HDBed
Binding: http://terminology.hl7.org/ValueSet/v2-0304 (required)
... 4 0..1HDFacility
... 5 0..1codeLocation Status
Binding: http://terminology.hl7.org/ValueSet/v2-0306 (required)
... 6 0..1codePerson Location Type
Binding: hl7VS-personLocationType (required)
... 7 0..1HDBuilding
Binding: http://terminology.hl7.org/ValueSet/v2-0307 (required)
... 8 0..1HDFloor
Binding: http://terminology.hl7.org/ValueSet/v2-0308 (required)
... 9 0..1stringLocation Description
... 10 0..1EIComprehensive Location Identifier
... 11 0..1HDAssigning Authority for Location
Binding: http://terminology.hl7.org/ValueSet/v2-0363 (required)

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "PL",
  "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/PL",
  "version": "0.0.0",
  "name": "PL",
  "title": "HL7 v2 PL 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:* This data type contains several location identifiers that should be thought of in the following order from the most general to the most specific: facility, building, floor, point of care, room, bed. +\n\nAdditional data about any location defined by these components can be added in the following components: person location type, location description and location status.\n\nExample: Nursing Unit\n\nA nursing unit at Community Hospital: 4 East, room 136, bed B\n\n4E^136^B^CommunityHospital^^N^^^\n\nExample: Clinic\n\nA clinic at University Hospitals: Internal Medicine Clinic located in the Briones building, 3^rd^ floor.\n\nInternalMedicine^^^UniversityHospitals^^C^Briones^3^\n\nExample: Home\n\nThe patient was treated at his home.\n\n^^^^^H^^^",
  "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/PL",
  "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": "PL",
        "path": "PL",
        "short": "person location",
        "definition": "Definition: This data type is used to specify a patient location within a healthcare institution. Which components are valued depends on the needs of the site. For example for a patient treated at home, only the person location type is valued. It is most commonly used for specifying patient locations, but may refer to other types of locations within a healthcare setting.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "PL.1",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "C"
          }
        ],
        "path": "PL.1",
        "short": "Point of Care",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.1",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0302"
        }
      },
      {
        "id": "PL.2",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.2",
        "short": "Room",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.2",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0303"
        }
      },
      {
        "id": "PL.3",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.3",
        "short": "Bed",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.3",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0304"
        }
      },
      {
        "id": "PL.4",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.4",
        "short": "Facility",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.4",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ]
      },
      {
        "id": "PL.5",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "length",
                "valueInteger": 20
              },
              {
                "url": "noTruncate",
                "valueBoolean": true
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/conformance-length"
          }
        ],
        "path": "PL.5",
        "short": "Location Status",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.5",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/IS"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0306"
        }
      },
      {
        "id": "PL.6",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "length",
                "valueInteger": 20
              },
              {
                "url": "noTruncate",
                "valueBoolean": true
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/conformance-length"
          }
        ],
        "path": "PL.6",
        "short": "Person Location Type",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.6",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/IS"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0305"
        }
      },
      {
        "id": "PL.7",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.7",
        "short": "Building",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.7",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0307"
        }
      },
      {
        "id": "PL.8",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.8",
        "short": "Floor",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.8",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0308"
        }
      },
      {
        "id": "PL.9",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "length",
                "valueInteger": 199
              },
              {
                "url": "noTruncate",
                "valueBoolean": true
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/conformance-length"
          }
        ],
        "path": "PL.9",
        "short": "Location Description",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.9",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ST"
          }
        ]
      },
      {
        "id": "PL.10",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.10",
        "short": "Comprehensive Location Identifier",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.10",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/EI"
          }
        ]
      },
      {
        "id": "PL.11",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.11",
        "short": "Assigning Authority for Location",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PL.11",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0363"
        }
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "PL",
        "path": "PL",
        "short": "person location",
        "definition": "Definition: This data type is used to specify a patient location within a healthcare institution. Which components are valued depends on the needs of the site. For example for a patient treated at home, only the person location type is valued. It is most commonly used for specifying patient locations, but may refer to other types of locations within a healthcare setting.",
        "min": 0,
        "max": "*"
      },
      {
        "id": "PL.1",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "C"
          }
        ],
        "path": "PL.1",
        "short": "Point of Care",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0302"
        }
      },
      {
        "id": "PL.2",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.2",
        "short": "Room",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0303"
        }
      },
      {
        "id": "PL.3",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.3",
        "short": "Bed",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0304"
        }
      },
      {
        "id": "PL.4",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.4",
        "short": "Facility",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ]
      },
      {
        "id": "PL.5",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "length",
                "valueInteger": 20
              },
              {
                "url": "noTruncate",
                "valueBoolean": true
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/conformance-length"
          }
        ],
        "path": "PL.5",
        "short": "Location Status",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/IS"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0306"
        }
      },
      {
        "id": "PL.6",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "length",
                "valueInteger": 20
              },
              {
                "url": "noTruncate",
                "valueBoolean": true
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/conformance-length"
          }
        ],
        "path": "PL.6",
        "short": "Person Location Type",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/IS"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0305"
        }
      },
      {
        "id": "PL.7",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.7",
        "short": "Building",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0307"
        }
      },
      {
        "id": "PL.8",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.8",
        "short": "Floor",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0308"
        }
      },
      {
        "id": "PL.9",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          },
          {
            "extension": [
              {
                "url": "length",
                "valueInteger": 199
              },
              {
                "url": "noTruncate",
                "valueBoolean": true
              }
            ],
            "url": "http://hl7.org/v2/StructureDefinition/conformance-length"
          }
        ],
        "path": "PL.9",
        "short": "Location Description",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/ST"
          }
        ]
      },
      {
        "id": "PL.10",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.10",
        "short": "Comprehensive Location Identifier",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/EI"
          }
        ]
      },
      {
        "id": "PL.11",
        "extension": [
          {
            "url": "http://hl7.org/v2/StructureDefinition/optionality",
            "valueCode": "O"
          }
        ],
        "path": "PL.11",
        "short": "Assigning Authority for Location",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/v2/StructureDefinition/HD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v2-0363"
        }
      }
    ]
  }
}