This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

8.2.11 JSON Schema for RelatedPerson

Patient Administration Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Patient, RelatedPerson

This is a representation of the json schema for RelatedPerson, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/RelatedPerson",
  "$ref": "#/definitions/RelatedPerson",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "RelatedPerson": {
      "description": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
      "properties": {
        "resourceType": {
          "description": "This is a RelatedPerson resource",
          "const": "RelatedPerson"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "meta": {
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "Identifier for a person within a particular scope.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "active": {
          "description": "Whether this related person record is in active use.",
          "$ref": "#/definitions/boolean"
        },
        "_active": {
          "description": "Extensions for active",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "patient": {
          "description": "The patient this person is related to.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "relationship": {
          "description": "The nature of the relationship between a patient and the related person.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "name": {
          "description": "A name associated with the person.",
          "items": {
            "$ref": "HumanName.schema.json#/definitions/HumanName"
          },
          "type": "array"
        },
        "telecom": {
          "description": "A contact detail for the person, e.g. a telephone number or an email address.",
          "items": {
            "$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
          },
          "type": "array"
        },
        "gender": {
          "description": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
          "$ref": "#/definitions/code"
        },
        "_gender": {
          "description": "Extensions for gender",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "birthDate": {
          "description": "The date on which the related person was born.",
          "$ref": "#/definitions/date"
        },
        "_birthDate": {
          "description": "Extensions for birthDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "address": {
          "description": "Address where the related person can be contacted or visited.",
          "items": {
            "$ref": "Address.schema.json#/definitions/Address"
          },
          "type": "array"
        },
        "photo": {
          "description": "Image of the person.",
          "items": {
            "$ref": "Attachment.schema.json#/definitions/Attachment"
          },
          "type": "array"
        },
        "period": {
          "description": "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "communication": {
          "description": "A language which may be used to communicate with about the patient\u0027s health.",
          "items": {
            "$ref": "#/definitions/RelatedPerson_Communication"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "patient",
        "resourceType"
      ]
    },
    "RelatedPerson_Communication": {
      "description": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "language": {
          "description": "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.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "preferred": {
          "description": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
          "$ref": "#/definitions/boolean"
        },
        "_preferred": {
          "description": "Extensions for preferred",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false,
      "required": [
        "language"
      ]
    }
  }
}