Relatedperson.profile.json

StructureDefinition for relatedperson

{
  "resourceType": "StructureDefinition",
  "id": "RelatedPerson",
  "meta": {
    "lastUpdated": "2015-04-03T14:24:32.000+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
  "name": "RelatedPerson",
  "publisher": "HL7 FHIR Project (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": "Base StructureDefinition for RelatedPerson Resource",
  "status": "draft",
  "date": "2015-04-03T14:24:32+11:00",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    },
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2"
    }
  ],
  "type": "resource",
  "abstract": true,
  "snapshot": {
    "element": [
      {
        "path": "RelatedPerson",
        "short": "An 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 the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
        "requirements": "Need to track persons related to the patient or the healthcare process.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "role"
          }
        ]
      },
      {
        "path": "RelatedPerson.id",
        "short": "Logical id of this artefact",
        "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
        "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "path": "RelatedPerson.meta",
        "short": "Metadata about the resource",
        "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Meta"
          }
        ]
      },
      {
        "path": "RelatedPerson.implicitRules",
        "short": "A set of rules under which this content was created",
        "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
        "comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isModifier": true
      },
      {
        "path": "RelatedPerson.language",
        "short": "Language of the resource content",
        "definition": "The base language in which the resource is written.",
        "comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "Language",
          "strength": "required",
          "description": "A human language",
          "valueSetUri": "http://tools.ietf.org/html/bcp47"
        }
      },
      {
        "path": "RelatedPerson.text",
        "short": "Text summary of the resource, for human interpretation",
        "definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
        "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
        "alias": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "condition": [
          "dom-1"
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Act.text?"
          }
        ]
      },
      {
        "path": "RelatedPerson.contained",
        "short": "Contained, inline Resources",
        "definition": "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.",
        "comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
        "alias": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "RelatedPerson.extension",
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
        "comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "RelatedPerson.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "definition": "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. Usually modifier elements provide negation or qualification. In order 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.",
        "comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "RelatedPerson.identifier",
        "short": "A Human identifier for this person",
        "definition": "Identifier for a person within a particular scope.",
        "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": "v2",
            "map": "NK1-33"
          },
          {
            "identity": "rim",
            "map": "id"
          }
        ]
      },
      {
        "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",
            "profile": "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"
          }
        ]
      },
      {
        "path": "RelatedPerson.relationship",
        "short": "The nature of the relationship",
        "definition": "The nature of the relationship between a patient and the related person.",
        "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": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "name": "PatientRelationshipType",
          "strength": "required",
          "description": "The nature of the relationship between a patient and the related person",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/relatedperson-relationshiptype"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-3"
          },
          {
            "identity": "rim",
            "map": "code"
          }
        ]
      },
      {
        "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": "1",
        "type": [
          {
            "code": "HumanName"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-2"
          },
          {
            "identity": "rim",
            "map": "name"
          }
        ]
      },
      {
        "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.",
        "comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay 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"
          }
        ]
      },
      {
        "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": {
          "name": "AdministrativeGender",
          "strength": "required",
          "description": "The gender of a person used for administrative purposes",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/administrative-gender"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-15"
          },
          {
            "identity": "rim",
            "map": "administrativeGender"
          }
        ]
      },
      {
        "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": "1",
        "type": [
          {
            "code": "Address"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-4"
          },
          {
            "identity": "rim",
            "map": "addr"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "path": "RelatedPerson.period",
        "short": "Period of time that this relationship is considered valid",
        "definition": "The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "RelatedPerson",
        "short": "An 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 the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
        "requirements": "Need to track persons related to the patient or the healthcare process.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "role"
          }
        ]
      },
      {
        "path": "RelatedPerson.identifier",
        "short": "A Human identifier for this person",
        "definition": "Identifier for a person within a particular scope.",
        "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": "v2",
            "map": "NK1-33"
          },
          {
            "identity": "rim",
            "map": "id"
          }
        ]
      },
      {
        "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",
            "profile": "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"
          }
        ]
      },
      {
        "path": "RelatedPerson.relationship",
        "short": "The nature of the relationship",
        "definition": "The nature of the relationship between a patient and the related person.",
        "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": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "name": "PatientRelationshipType",
          "strength": "required",
          "description": "The nature of the relationship between a patient and the related person",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/relatedperson-relationshiptype"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-3"
          },
          {
            "identity": "rim",
            "map": "code"
          }
        ]
      },
      {
        "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": "1",
        "type": [
          {
            "code": "HumanName"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-2"
          },
          {
            "identity": "rim",
            "map": "name"
          }
        ]
      },
      {
        "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.",
        "comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay 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"
          }
        ]
      },
      {
        "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": {
          "name": "AdministrativeGender",
          "strength": "required",
          "description": "The gender of a person used for administrative purposes",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/administrative-gender"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-15"
          },
          {
            "identity": "rim",
            "map": "administrativeGender"
          }
        ]
      },
      {
        "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": "1",
        "type": [
          {
            "code": "Address"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "NK1-4"
          },
          {
            "identity": "rim",
            "map": "addr"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "path": "RelatedPerson.period",
        "short": "Period of time that this relationship is considered valid",
        "definition": "The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      }
    ]
  }
}