{
  "resourceType": "StructureDefinition",
  "id": "RelatedPerson",
  "meta": {
    "lastUpdated": "2021-01-01T21:58:31.578+00:00"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Base.Individuals"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 2
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "patient"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pa"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
      "valueCode": ".active = false"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
  "version": "4.6.0",
  "name": "RelatedPerson",
  "status": "draft",
  "date": "2021-01-01T21:58:31+00:00",
  "publisher": "Health Level Seven International (Patient Administration)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
        }
      ]
    }
  ],
  "description": "Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
  "purpose": "Need to track persons related to the patient or the healthcare process.",
  "fhirVersion": "4.6.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "interface",
      "uri": "http://hl7.org/fhir/interface",
      "name": "Interface Pattern"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "RelatedPerson",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
  "derivation": "specialization",
  "differential": {
    "element": [
      {
        "id": "RelatedPerson",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
            "valueString": "Patient contact is defined as a person in role. Hence RelatedPerson should also be a person in role. Struggling with HL7 v3 mappings here."
          }
        ],
        "path": "RelatedPerson",
        "short": "A person that is related to a patient, but who is not a direct target of care",
        "definition": "Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
        "min": 0,
        "max": "*",
        "mapping": [
          {
            "identity": "rim",
            "map": "role"
          },
          {
            "identity": "interface",
            "map": "ParticipantLiving"
          },
          {
            "identity": "w5",
            "map": "administrative.individual"
          }
        ]
      },
      {
        "id": "RelatedPerson.identifier",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
            "valueString": "Keeping RelatedPerson.id cardinality as a matter of safety in the same manner as Person Activate."
          }
        ],
        "path": "RelatedPerson.identifier",
        "short": "A human identifier for this person",
        "definition": "Identifier for a person within a particular scope.",
        "comment": "RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.",
        "requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          },
          {
            "identity": "v2",
            "map": "NK1-33"
          },
          {
            "identity": "rim",
            "map": ".id"
          },
          {
            "identity": "interface",
            "map": "Participant.identifier"
          }
        ]
      },
      {
        "id": "RelatedPerson.active",
        "path": "RelatedPerson.active",
        "short": "Whether this related person's record is in active use",
        "definition": "Whether this related person record is in active use.",
        "comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
        "requirements": "Need to be able to mark a related person record as not to be used, such as if it was created in error.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
        "isModifier": true,
        "isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
        "isSummary": true,
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.status"
          },
          {
            "identity": "rim",
            "map": ".statusCode"
          },
          {
            "identity": "interface",
            "map": "Participant.active"
          }
        ]
      },
      {
        "id": "RelatedPerson.patient",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
            "valueString": "This rather complicated HL7 v3 mapping traverses the same path that the Patient resource has for contact but in opposite direction."
          }
        ],
        "path": "RelatedPerson.patient",
        "short": "The patient this person is related to",
        "definition": "The patient this person is related to.",
        "requirements": "We need to know which patient this RelatedPerson is related to.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient"
            ]
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "PID-3"
          },
          {
            "identity": "rim",
            "map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"
          }
        ]
      },
      {
        "id": "RelatedPerson.relationship",
        "path": "RelatedPerson.relationship",
        "short": "The relationship of the related person to the patient",
        "definition": "The nature of the relationship between the related person and the patient.",
        "comment": "The directionality of the relationship is from the RelatedPerson to the Patient. For example, if the Patient is a child, and the RelatedPerson is the mother, the relationship would be PRN (parent) or MTH (mother).",
        "requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "PatientRelationshipType"
            }
          ],
          "strength": "preferred",
          "description": "The nature of the relationship between a patient and the related person.",
          "valueSet": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"
        },
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.class"
          },
          {
            "identity": "v2",
            "map": "NK1-3"
          },
          {
            "identity": "rim",
            "map": "code"
          }
        ]
      },
      {
        "id": "RelatedPerson.name",
        "path": "RelatedPerson.name",
        "short": "A name associated with the person",
        "definition": "A name associated with the person.",
        "requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "HumanName"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-2"
          },
          {
            "identity": "rim",
            "map": "name"
          },
          {
            "identity": "interface",
            "map": "Participant.name"
          }
        ]
      },
      {
        "id": "RelatedPerson.telecom",
        "path": "RelatedPerson.telecom",
        "short": "A contact detail for the person",
        "definition": "A contact detail for the person, e.g. a telephone number or an email address.",
        "comment": "Person may have multiple ways to be contacted with different uses or applicable periods.  May need to have options for contacting the person urgently, and also to help with identification.",
        "requirements": "People have (primary) ways to contact them in some way such as phone, email.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "ContactPoint"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-5 / NK1-6 / NK1-40"
          },
          {
            "identity": "rim",
            "map": "telecom"
          },
          {
            "identity": "interface",
            "map": "ParticipantContactable.telecom"
          }
        ]
      },
      {
        "id": "RelatedPerson.gender",
        "path": "RelatedPerson.gender",
        "short": "male | female | other | unknown",
        "definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
        "requirements": "Needed for identification of the person, in combination with (at least) name and birth date.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "AdministrativeGender"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org/fhir/build/StructureDefinition/v2-map",
              "valueString": "http://terminology.hl7.org/ValueSet/v2-0001"
            },
            {
              "url": "http://hl7.org/fhir/build/StructureDefinition/v3-map",
              "valueString": "http://terminology.hl7.org/ValueSet/v3-AdministrativeGender"
            }
          ],
          "strength": "required",
          "description": "The gender of a person used for administrative purposes.",
          "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender"
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-15"
          },
          {
            "identity": "rim",
            "map": "administrativeGender"
          },
          {
            "identity": "interface",
            "map": "ParticipantLiving.gender"
          }
        ]
      },
      {
        "id": "RelatedPerson.birthDate",
        "path": "RelatedPerson.birthDate",
        "short": "The date on which the related person was born",
        "definition": "The date on which the related person was born.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "player.birthTime"
          },
          {
            "identity": "interface",
            "map": "ParticipantLiving.birthDate"
          }
        ]
      },
      {
        "id": "RelatedPerson.address",
        "path": "RelatedPerson.address",
        "short": "Address where the related person can be contacted or visited",
        "definition": "Address where the related person can be contacted or visited.",
        "requirements": "Need to keep track where the related person can be contacted per postal mail or visited.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Address"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-4"
          },
          {
            "identity": "rim",
            "map": "addr"
          },
          {
            "identity": "interface",
            "map": "ParticipantContactable.address"
          }
        ]
      },
      {
        "id": "RelatedPerson.photo",
        "path": "RelatedPerson.photo",
        "short": "Image of the person",
        "definition": "Image of the person.",
        "requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Attachment"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "OBX-5 - needs a profile"
          },
          {
            "identity": "rim",
            "map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc"
          },
          {
            "identity": "interface",
            "map": "ParticipantLiving.photo"
          }
        ]
      },
      {
        "id": "RelatedPerson.period",
        "path": "RelatedPerson.period",
        "short": "Period of time that this relationship is considered valid",
        "definition": "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.",
        "comment": "If an individual has a relationship with a patient over multiple, non-adjacent periods, there should be a distinct RelatedPerson instance for each period.  For example, if a person is a roommate for a period of time, moves out, and is later a roommate with the same person again, you would have two RelatedPerson instances.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ],
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.done[x]"
          },
          {
            "identity": "rim",
            "map": ".effectiveTime"
          }
        ]
      },
      {
        "id": "RelatedPerson.communication",
        "path": "RelatedPerson.communication",
        "short": "A language which may be used to communicate with the related person about the patient's health",
        "definition": "A language which may be used to communicate with the related person about the patient's health.",
        "comment": "If no language is specified, this *implies* that the default local language is spoken.  If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations.   If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
        "requirements": "If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "LanguageCommunication"
          },
          {
            "identity": "interface",
            "map": "ParticipantLiving.communication"
          }
        ]
      },
      {
        "id": "RelatedPerson.communication.language",
        "path": "RelatedPerson.communication.language",
        "short": "The language which can be used to communicate with the related person about the patient's health",
        "definition": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
        "comment": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
        "requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "Language"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
              "valueBoolean": true
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
              "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
            },
            {
              "url": "http://hl7.org/fhir/build/StructureDefinition/definition",
              "valueString": "A human language."
            }
          ],
          "strength": "preferred",
          "description": "IETF language tag",
          "valueSet": "http://hl7.org/fhir/ValueSet/languages"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
          }
        ]
      },
      {
        "id": "RelatedPerson.communication.preferred",
        "path": "RelatedPerson.communication.preferred",
        "short": "Language preference indicator",
        "definition": "Indicates whether or not the related person prefers this language (over other languages he or she masters up a certain level).",
        "comment": "This language is specifically identified for communicating healthcare information.",
        "requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "preferenceInd"
          }
        ]
      }
    ]
  }
}