Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/relationship (JSON)

Financial Management Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Code SystemBeneficiaryRelationshipCodes

{
  "resourceType" : "CodeSystem",
  "id" : "relationship",
  "meta" : {
    "lastUpdated" : "2023-03-26T15:21:02.749+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/relationship</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">1<a name=\"relationship-1\"> </a></td><td>Self</td><td>The patient is the subscriber (policy holder)</td></tr><tr><td style=\"white-space:nowrap\">2<a name=\"relationship-2\"> </a></td><td>Spouse</td><td>The patient is the spouse or equivalent of the subscriber (policy holder)</td></tr><tr><td style=\"white-space:nowrap\">3<a name=\"relationship-3\"> </a></td><td>Child</td><td>The patient is the child of the subscriber (policy holder)</td></tr><tr><td style=\"white-space:nowrap\">4<a name=\"relationship-4\"> </a></td><td>Common Law Spouse</td><td>The patient is the common law spouse of the subscriber (policy holder)</td></tr><tr><td style=\"white-space:nowrap\">5<a name=\"relationship-5\"> </a></td><td>Other</td><td>The patient has some other relationship, such as parent, to the subscriber (policy holder)</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fm"
  }],
  "url" : "http://hl7.org/fhir/relationship",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.36"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.35"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.2.23"
  }],
  "version" : "5.0.0",
  "name" : "BeneficiaryRelationshipCodes",
  "title" : "Beneficiary Relationship Codes",
  "status" : "draft",
  "experimental" : true,
  "publisher" : "FHIR Project team",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "This value set includes the Patient to subscriber relationship codes.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "copyright" : "This is an example set.",
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/relationship",
  "content" : "complete",
  "concept" : [{
    "code" : "1",
    "display" : "Self",
    "definition" : "The patient is the subscriber (policy holder)"
  },
  {
    "code" : "2",
    "display" : "Spouse",
    "definition" : "The patient is the spouse or equivalent of the subscriber (policy holder)"
  },
  {
    "code" : "3",
    "display" : "Child",
    "definition" : "The patient is the child of the subscriber (policy holder)"
  },
  {
    "code" : "4",
    "display" : "Common Law Spouse",
    "definition" : "The patient is the common law spouse of the subscriber (policy holder)"
  },
  {
    "code" : "5",
    "display" : "Other",
    "definition" : "The patient has some other relationship, such as parent, to the subscriber (policy holder)"
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.