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

FHIR IG Statistics: StructureDefinition/England-RelatedPerson-PDS

Packagefhir.r4.nhsengland.programme
Resource TypeStructureDefinition
IdEngland-RelatedPerson-PDS
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=fhir.r4.nhsengland.programme@0.2.2-pre-release&canonical=https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS
URLhttps://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS
Version0.0.1-current
Statusdraft
Date2024-10-25T07:31:19+00:00
NameEnglandRelatedPersonPDS
TitleEngland Related Person PDS
Realmus
Authorityhl7
DescriptionBased on [NHS England Confluence - Related Person Network - Physical Data Model - LPG](https://nhsd-confluence.digital.nhs.uk/display/DEMGRPH/Related+Person+Network+-+Physical+Data+Model+-+LPG#RelatedPersonNetworkPhysicalDataModelLPG-Appendix-FHIRRelatedPersonAPI-Example)
PurposeThis documents requirement for NHS England PDS
CopyrightCopyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.
TypeRelatedPerson
Kindresource

Resources that use this resource

CapabilityStatement
England-PDSRelatedPersonRequirementsCapabilityStatement England PDS RelatedPerson Requirements

Resources that this resource uses

StructureDefinition
England-Identifier-NHS-NumberEngland Identifier NHS Number
Extension-England-Next-of-Kin-StatusExtension England Next of Kin Status
Extension-UKCore-AddressKeyExtension UK Core Address Key
Extension-UKCore-ContactRankExtension UK Core Contact Rank
UKCore-RelatedPersonUK Core Related Person
ValueSet
England-PDSRelationshipTypeEngland PDS Relationship Type

Narrative

No narrative content found in resource


Source

{
  "resourceType": "StructureDefinition",
  "id": "England-RelatedPerson-PDS",
  "url": "https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS",
  "version": "0.0.1-current",
  "name": "EnglandRelatedPersonPDS",
  "title": "England Related Person PDS",
  "status": "draft",
  "date": "2024-10-25T07:31:19+00:00",
  "publisher": "NHS England",
  "contact": [
    {
      "name": "NHS England",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net",
          "use": "work",
          "rank": 1
        }
      ]
    }
  ],
  "description": "Based on [NHS England Confluence - Related Person Network - Physical Data Model - LPG](https://nhsd-confluence.digital.nhs.uk/display/DEMGRPH/Related+Person+Network+-+Physical+Data+Model+-+LPG#RelatedPersonNetworkPhysicalDataModelLPG-Appendix-FHIRRelatedPersonAPI-Example)",
  "purpose": "This documents requirement for NHS England PDS",
  "copyright": "Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "RelatedPerson",
  "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "RelatedPerson.extension:ContactRank",
        "path": "RelatedPerson.extension",
        "sliceName": "ContactRank",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"
            ]
          }
        ]
      },
      {
        "id": "RelatedPerson.extension:interpreterRequired",
        "path": "RelatedPerson.extension",
        "sliceName": "interpreterRequired",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
            ]
          }
        ]
      },
      {
        "id": "RelatedPerson.extension:nextofKinStatus",
        "path": "RelatedPerson.extension",
        "sliceName": "nextofKinStatus",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Next-of-Kin-Status"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "RelatedPerson.identifier",
        "path": "RelatedPerson.identifier",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "system"
            }
          ],
          "rules": "closed"
        },
        "mustSupport": true
      },
      {
        "id": "RelatedPerson.identifier:NHSNumber",
        "path": "RelatedPerson.identifier",
        "sliceName": "NHSNumber",
        "max": "1",
        "type": [
          {
            "code": "Identifier",
            "profile": [
              "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number"
            ]
          }
        ]
      },
      {
        "id": "RelatedPerson.patient.identifier",
        "path": "RelatedPerson.patient.identifier",
        "type": [
          {
            "code": "Identifier",
            "profile": [
              "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number"
            ]
          }
        ]
      },
      {
        "id": "RelatedPerson.relationship",
        "path": "RelatedPerson.relationship",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "coding.system"
            }
          ],
          "rules": "openAtEnd"
        },
        "min": 1,
        "max": "3"
      },
      {
        "id": "RelatedPerson.relationship.coding",
        "path": "RelatedPerson.relationship.coding",
        "min": 1,
        "max": "1",
        "binding": {
          "strength": "preferred",
          "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-PDSRelationshipType"
        }
      },
      {
        "id": "RelatedPerson.relationship.coding.system",
        "path": "RelatedPerson.relationship.coding.system",
        "min": 1
      },
      {
        "id": "RelatedPerson.relationship.coding.code",
        "path": "RelatedPerson.relationship.coding.code",
        "min": 1
      },
      {
        "id": "RelatedPerson.relationship:Role",
        "path": "RelatedPerson.relationship",
        "sliceName": "Role",
        "max": "2"
      },
      {
        "id": "RelatedPerson.relationship:Role.coding.system",
        "path": "RelatedPerson.relationship.coding.system",
        "patternUri": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole"
      },
      {
        "id": "RelatedPerson.relationship:Type",
        "path": "RelatedPerson.relationship",
        "sliceName": "Type",
        "max": "1"
      },
      {
        "id": "RelatedPerson.relationship:Type.coding.system",
        "path": "RelatedPerson.relationship.coding.system",
        "patternUri": "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
      },
      {
        "id": "RelatedPerson.relationship:NextOfKin",
        "path": "RelatedPerson.relationship",
        "sliceName": "NextOfKin",
        "max": "1"
      },
      {
        "id": "RelatedPerson.relationship:NextOfKin.coding.system",
        "path": "RelatedPerson.relationship.coding.system",
        "patternUri": "http://terminology.hl7.org/CodeSystem/v2-0131"
      },
      {
        "id": "RelatedPerson.name",
        "path": "RelatedPerson.name",
        "min": 1,
        "max": "1"
      },
      {
        "id": "RelatedPerson.name.use",
        "path": "RelatedPerson.name.use",
        "min": 1
      },
      {
        "id": "RelatedPerson.name.period.start",
        "path": "RelatedPerson.name.period.start",
        "min": 1
      },
      {
        "id": "RelatedPerson.telecom.value",
        "path": "RelatedPerson.telecom.value",
        "min": 1
      },
      {
        "id": "RelatedPerson.telecom.use",
        "path": "RelatedPerson.telecom.use",
        "min": 1
      },
      {
        "id": "RelatedPerson.telecom.period.start",
        "path": "RelatedPerson.telecom.period.start",
        "min": 1
      },
      {
        "id": "RelatedPerson.birthDate",
        "path": "RelatedPerson.birthDate",
        "mustSupport": true
      },
      {
        "id": "RelatedPerson.address.extension:AddressKey",
        "path": "RelatedPerson.address.extension",
        "sliceName": "AddressKey",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"
            ]
          }
        ]
      },
      {
        "id": "RelatedPerson.address.use",
        "path": "RelatedPerson.address.use",
        "min": 1
      },
      {
        "id": "RelatedPerson.address.period.start",
        "path": "RelatedPerson.address.period.start",
        "min": 1
      },
      {
        "id": "RelatedPerson.period.start",
        "path": "RelatedPerson.period.start",
        "min": 1
      }
    ]
  }
}