Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build United Kingdom flag

Virtually Healthcare HL7 FHIR R4 Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

: PDS RelatedPerson Relationship Type - JSON Representation

Draft as of 2024-12-02

Raw json | Download

{
  "resourceType" : "ValueSet",
  "id" : "PDSRelatedPersonRelationshipType",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ValueSet PDSRelatedPersonRelationshipType</b></p><a name=\"PDSRelatedPersonRelationshipType\"> </a><a name=\"hcPDSRelatedPersonRelationshipType\"> </a><a name=\"PDSRelatedPersonRelationshipType-en-GB\"> </a><p>This value set includes codes based on the following rules:</p><ul><li>Include these codes as defined in <a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"><code>https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole</code></a><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-Agent\">Agent</a></td><td>Agent of patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-Guardian\">Guardian</a></td><td>Guardian of patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-Personal\">Personal</a></td><td>Personal relationship with the patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-PolygamousPartner\">PolygamousPartner</a></td><td style=\"color: #cccccc\">Polygamous Partner of patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-Dependant\">Dependant</a></td><td style=\"color: #cccccc\">Dependant of patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-NonDependant\">NonDependant</a></td><td style=\"color: #cccccc\">Non Dependant of patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-ProxyContact\">ProxyContact</a></td><td style=\"color: #cccccc\">Proxy Contact for patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-ProxyCommunication\">ProxyCommunication</a></td><td style=\"color: #cccccc\">Proxy Communication for patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-ProxyContactCommunication\">ProxyContactCommunication</a></td><td style=\"color: #cccccc\">Proxy Contact and Communication for patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-Carer\">Carer</a></td><td style=\"color: #cccccc\">Carer of patient</td></tr><tr><td><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu3.currentbuild@0.0.15-pre-release&amp;canonical=https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole#UKCore-AdditionalPersonRelationshipRole-NotSpecified\">NotSpecified</a></td><td style=\"color: #cccccc\">Not Specified</td></tr></table></li><li>Include these codes as defined in <a href=\"http://terminology.hl7.org/5.0.0/CodeSystem-v2-0131.html\"><code>http://terminology.hl7.org/CodeSystem/v2-0131</code></a><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td><a href=\"http://terminology.hl7.org/5.0.0/CodeSystem-v2-0131.html#v2-0131-N\">N</a></td><td>Next-of-Kin</td><td>Next-of-Kin</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.0.0/CodeSystem-v2-0131.html#v2-0131-U\">U</a></td><td style=\"color: #cccccc\">Unknown</td><td>Unknown</td></tr></table></li><li>Include these codes as defined in <a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html\"><code>http://terminology.hl7.org/CodeSystem/v3-RoleCode</code></a><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-SPS\">SPS</a></td><td style=\"color: #cccccc\">spouse</td><td>The player of the role is a marriage partner of the scoping person.</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-DOMPART\">DOMPART</a></td><td style=\"color: #cccccc\">domestic partner</td><td>The player of the role cohabits with the scoping person but is not the scoping person's spouse.</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-PRN\">PRN</a></td><td style=\"color: #cccccc\">parent</td><td>The player of the role is one who begets, gives birth to, or nurtures and raises the scoping entity (child).</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-PRNFOST\">PRNFOST</a></td><td style=\"color: #cccccc\">foster parent</td><td>The player of the role (parent) who is a state-certified caregiver responsible for the scoper (child) who has been placed in the parent's care. The placement of the child is usually arranged through the government or a social-service agency, and temporary.<br/><br/>The state, via a jurisdiction recognized child protection agency, stands as in loco parentis to the child, making all legal decisions while the foster parent is responsible for the day-to-day care of the specified child.</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-STPPRN\">STPPRN</a></td><td style=\"color: #cccccc\">step parent</td><td>The player of the role is the spouse of the scoping person's parent and not the scoping person's natural parent.</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-CHILD\">CHILD</a></td><td style=\"color: #cccccc\">child</td><td>The player of the role is a child of the scoping entity.</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-MTH\">MTH</a></td><td style=\"color: #cccccc\">mother</td><td>The player of the role is a female who conceives, gives birth to, or raises and nurtures the scoping entity (child).</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-FTH\">FTH</a></td><td style=\"color: #cccccc\">father</td><td>The player of the role is a male who begets or raises or nurtures the scoping entity (child).</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-SIS\">SIS</a></td><td style=\"color: #cccccc\">sister</td><td>The player of the role is a female sharing one or both parents in common with the scoping entity.</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-BRO\">BRO</a></td><td style=\"color: #cccccc\">brother</td><td>The player of the role is a male sharing one or both parents in common with the scoping entity.</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-FAMMEMB\">FAMMEMB</a></td><td style=\"color: #cccccc\">family member</td><td>A relationship between two people characterizing their &quot;familial&quot; relationship</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-ONESELF\">ONESELF</a></td><td style=\"color: #cccccc\">self</td><td>The relationship that a person has with his or her self.</td></tr><tr><td><a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-RoleCode.html#v3-RoleCode-NOK\">NOK</a></td><td style=\"color: #cccccc\">next of kin</td><td>Played by an individual who is designated as the next of kin for another individual which scopes the role.</td></tr></table></li></ul></div>"
  },
  "url" : "https://fhir.virtually.healthcare/ValueSet/PDSRelatedPersonRelationshipType",
  "version" : "0.1.0-current",
  "name" : "PDSRelatedPersonRelationshipType",
  "title" : "PDS RelatedPerson Relationship Type",
  "status" : "draft",
  "experimental" : false,
  "date" : "2024-12-02T14:10:35+00:00",
  "publisher" : "Virtually Healthcare",
  "contact" : [
    {
      "name" : "Virtually Healthcare",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://virtually.healthcare"
        }
      ]
    }
  ],
  "description" : "Extracted from [PDS FHIR API - Get a patient's related people](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir#get-/Patient/-id-/RelatedPerson)",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "GB",
          "display" : "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "compose" : {
    "include" : [
      {
        "system" : "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole",
        "concept" : [
          {
            "code" : "Agent",
            "display" : "Agent of patient"
          },
          {
            "code" : "Guardian",
            "display" : "Guardian of patient"
          },
          {
            "code" : "Personal",
            "display" : "Personal relationship with the patient"
          },
          {
            "code" : "PolygamousPartner"
          },
          {
            "code" : "Dependant"
          },
          {
            "code" : "NonDependant"
          },
          {
            "code" : "ProxyContact"
          },
          {
            "code" : "ProxyCommunication"
          },
          {
            "code" : "ProxyContactCommunication"
          },
          {
            "code" : "Carer"
          },
          {
            "code" : "NotSpecified"
          }
        ]
      },
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0131",
        "concept" : [
          {
            "code" : "N",
            "display" : "Next-of-Kin"
          },
          {
            "code" : "U"
          }
        ]
      },
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
        "concept" : [
          {
            "code" : "SPS"
          },
          {
            "code" : "DOMPART"
          },
          {
            "code" : "PRN"
          },
          {
            "code" : "PRNFOST"
          },
          {
            "code" : "STPPRN"
          },
          {
            "code" : "CHILD"
          },
          {
            "code" : "MTH"
          },
          {
            "code" : "FTH"
          },
          {
            "code" : "SIS"
          },
          {
            "code" : "BRO"
          },
          {
            "code" : "FAMMEMB"
          },
          {
            "code" : "ONESELF"
          },
          {
            "code" : "NOK"
          }
        ]
      }
    ]
  }
}