International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1 International flag

This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Personal Relationship - IPS [Deprecated] - JSON Representation

Page standards status: Trial-use Maturity Level: 2

Raw json | Download


{
  "resourceType" : "ValueSet",
  "id" : "personal-relationship-uv-ips",
  "meta" : {
    "profile" : [
      "http://hl7.org/fhir/StructureDefinition/shareablevalueset"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>Include these codes as defined in <a href=\"http://terminology.hl7.org/4.0.0/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/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-AUNT\">AUNT</a></td><td>aunt</td><td>The player of the role is a sister of the scoping person's mother or father.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-CHILD\">CHILD</a></td><td>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/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-CHLDADOPT\">CHLDADOPT</a></td><td>adopted child</td><td>The player of the role is a child taken into a family through legal means and raised by the scoping person (parent) as his or her own child.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-CHLDFOST\">CHLDFOST</a></td><td>foster child</td><td>The player of the role is a child receiving parental care and nurture from the scoping person (parent) but not related to him or her through legal or blood ties.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-CHLDINLAW\">CHLDINLAW</a></td><td>child in-law</td><td>The player of the role is the spouse of scoping person's child.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-COUSN\">COUSN</a></td><td>cousin</td><td>The player of the role is a relative of the scoping person descended from a common ancestor, such as a grandparent, by two or more steps in a diverging line.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-DAU\">DAU</a></td><td>natural daughter</td><td>The player of the role is a female offspring of the scoping entity (parent).</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-DAUADOPT\">DAUADOPT</a></td><td>adopted daughter</td><td>The player of the role is a female child taken into a family through legal means and raised by the scoping person (parent) as his or her own child.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-DAUC\">DAUC</a></td><td>daughter</td><td>**Description:** The player of the role is a female child (of any type) of scoping entity (parent)</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-DAUFOST\">DAUFOST</a></td><td>foster daughter</td><td>The player of the role is a female child receiving parental care and nurture from the scoping person (parent) but not related to him or her through legal or blood ties.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-DAUINLAW\">DAUINLAW</a></td><td>daughter in-law</td><td>The player of the role is the wife of scoping person's son.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-DOMPART\">DOMPART</a></td><td>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/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-FAMMEMB\">FAMMEMB</a></td><td>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/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-FRND\">FRND</a></td><td>unrelated friend</td><td>The player of the role is a person who is known, liked, and trusted by the scoping person.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-FTH\">FTH</a></td><td>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/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-FTHINLAW\">FTHINLAW</a></td><td>father-in-law</td><td>The player of the role is the father of the scoping person's husband or wife.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-GGRPRN\">GGRPRN</a></td><td>great grandparent</td><td>The player of the role is a parent of the scoping person's grandparent.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-GRNDCHILD\">GRNDCHILD</a></td><td>grandchild</td><td>The player of the role is a child of the scoping person's son or daughter.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-GRPRN\">GRPRN</a></td><td>grandparent</td><td>The player of the role is a parent of the scoping person's mother or father.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-MTH\">MTH</a></td><td>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/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-MTHINLAW\">MTHINLAW</a></td><td>mother-in-law</td><td>The player of the role is the mother of the scoping person's husband or wife.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-NBOR\">NBOR</a></td><td>neighbor</td><td>The player of the role lives near or next to the scoping person.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-NCHILD\">NCHILD</a></td><td>natural child</td><td>The player of the role is an offspring of the scoping entity as determined by birth.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-NIENEPH\">NIENEPH</a></td><td>niece/nephew</td><td>The player of the role is a child of scoping person's brother or sister or of the brother or sister of the scoping person's spouse.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-PRN\">PRN</a></td><td>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/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-PRNINLAW\">PRNINLAW</a></td><td>parent in-law</td><td>The player of the role is the parent of scoping person's husband or wife.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-ROOM\">ROOM</a></td><td>roomate</td><td>One who shares living quarters with the subject.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SIB\">SIB</a></td><td>sibling</td><td>The player of the role shares one or both parents in common with the scoping entity.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SIGOTHR\">SIGOTHR</a></td><td>significant other</td><td>A person who is important to one's well being; especially a spouse or one in a similar relationship. (The player is the one who is important)</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SON\">SON</a></td><td>natural son</td><td>The player of the role is a male offspring of the scoping entity (parent).</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SONADOPT\">SONADOPT</a></td><td>adopted son</td><td>The player of the role is a male child taken into a family through legal means and raised by the scoping person (parent) as his or her own child.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SONC\">SONC</a></td><td>son</td><td>**Description:** The player of the role is a male child (of any type) of scoping entity (parent)</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SONFOST\">SONFOST</a></td><td>foster son</td><td>The player of the role is a male child receiving parental care and nurture from the scoping person (parent) but not related to him or her through legal or blood ties.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SONINLAW\">SONINLAW</a></td><td>son in-law</td><td>The player of the role is the husband of scoping person's daughter.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-SPS\">SPS</a></td><td>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/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-STPCHLD\">STPCHLD</a></td><td>step child</td><td>The player of the role is a child of the scoping person's spouse by a previous union.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-STPDAU\">STPDAU</a></td><td>stepdaughter</td><td>The player of the role is a daughter of the scoping person's spouse by a previous union.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-STPSON\">STPSON</a></td><td>stepson</td><td>The player of the role is a son of the scoping person's spouse by a previous union.</td></tr><tr><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-RoleCode.html#v3-RoleCode-UNCLE\">UNCLE</a></td><td>uncle</td><td>The player of the role is a brother of the scoping person's mother or father.</td></tr></table></li></ul></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/ips/ImplementationGuide/ig-uv-ips"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/ips/ImplementationGuide/ig-uv-ips"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/ips/ValueSet/personal-relationship-uv-ips",
  "identifier" : [
    {
      "use" : "official",
      "system" : "http://art-decor.org/ns/oids/vs",
      "value" : "2.16.840.1.113883.11.22.54"
    }
  ],
  "version" : "1.1.0",
  "name" : "PersonalRelationshipUvIps",
  "title" : "Personal Relationship - IPS [Deprecated]",
  "status" : "active",
  "experimental" : false,
  "date" : "2022-11-22T03:24:39+00:00",
  "publisher" : "Health Level Seven International - Patient Care Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/patientcare"
        }
      ]
    }
  ],
  "description" : "The Value Set is used (optionally) to code the type of contact relationship between a person and the patient. This value set has been deprecated and will be removed in a future release.  It has been replaced with [PersonalRelationshipRoleType](https://terminology.hl7.org/3.1.0/ValueSet-v3-PersonalRelationshipRoleType.html)",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "immutable" : false,
  "copyright" : "Produced by HL7 under the terms of HL7® Governance and Operations Manual relating to Intellectual Property (Section 16), specifically its copyright, trademark and patent provisions.",
  "compose" : {
    "include" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
        "concept" : [
          {
            "code" : "AUNT",
            "display" : "aunt"
          },
          {
            "code" : "CHILD",
            "display" : "child"
          },
          {
            "code" : "CHLDADOPT",
            "display" : "adopted child"
          },
          {
            "code" : "CHLDFOST",
            "display" : "foster child"
          },
          {
            "code" : "CHLDINLAW",
            "display" : "child in-law"
          },
          {
            "code" : "COUSN",
            "display" : "cousin"
          },
          {
            "code" : "DAU",
            "display" : "natural daughter"
          },
          {
            "code" : "DAUADOPT",
            "display" : "adopted daughter"
          },
          {
            "code" : "DAUC",
            "display" : "daughter"
          },
          {
            "code" : "DAUFOST",
            "display" : "foster daughter"
          },
          {
            "code" : "DAUINLAW",
            "display" : "daughter in-law"
          },
          {
            "code" : "DOMPART",
            "display" : "domestic partner"
          },
          {
            "code" : "FAMMEMB",
            "display" : "family member"
          },
          {
            "code" : "FRND",
            "display" : "unrelated friend"
          },
          {
            "code" : "FTH",
            "display" : "father"
          },
          {
            "code" : "FTHINLAW",
            "display" : "father-in-law"
          },
          {
            "code" : "GGRPRN",
            "display" : "great grandparent"
          },
          {
            "code" : "GRNDCHILD",
            "display" : "grandchild"
          },
          {
            "code" : "GRPRN",
            "display" : "grandparent"
          },
          {
            "code" : "MTH",
            "display" : "mother"
          },
          {
            "code" : "MTHINLAW",
            "display" : "mother-in-law"
          },
          {
            "code" : "NBOR",
            "display" : "neighbor"
          },
          {
            "code" : "NCHILD",
            "display" : "natural child"
          },
          {
            "code" : "NIENEPH",
            "display" : "niece/nephew"
          },
          {
            "code" : "PRN",
            "display" : "parent"
          },
          {
            "code" : "PRNINLAW",
            "display" : "parent in-law"
          },
          {
            "code" : "ROOM",
            "display" : "roomate"
          },
          {
            "code" : "SIB",
            "display" : "sibling"
          },
          {
            "code" : "SIGOTHR",
            "display" : "significant other"
          },
          {
            "code" : "SON",
            "display" : "natural son"
          },
          {
            "code" : "SONADOPT",
            "display" : "adopted son"
          },
          {
            "code" : "SONC",
            "display" : "son"
          },
          {
            "code" : "SONFOST",
            "display" : "foster son"
          },
          {
            "code" : "SONINLAW",
            "display" : "son in-law"
          },
          {
            "code" : "SPS",
            "display" : "spouse"
          },
          {
            "code" : "STPCHLD",
            "display" : "step child"
          },
          {
            "code" : "STPDAU",
            "display" : "stepdaughter"
          },
          {
            "code" : "STPSON",
            "display" : "stepson"
          },
          {
            "code" : "UNCLE",
            "display" : "uncle"
          }
        ]
      }
    ]
  }
}