. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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 R3 R2
Profile for relatedperson
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson\"><b>RelatedPerson</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for a person within a particular scope.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">A Human identifier for this person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The patient this person is related to.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">The patient this person is related to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The nature of the relationship between a patient and the related person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.relationship\"><b>relationship</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-relatedperson-relationshiptype.html\">The nature of the relationship<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"Address where the related person can be contacted or visited.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Address where the related person can be contacted or visited<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n</RelatedPerson>\r\n</pre></div>"
},
"name": "relatedperson",
"publisher": "FHIR Project",
"description": "Basic Profile. 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.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage RelatedPersons typically have a personal or non-healthcare-specific professional relationship to the patient. A RelatedPerson resource is primarily used for attribution of information, since RelatedPersons are often a source of information about the patient. For keeping information about persons for contact purposes for a patient, use a Patient's Contact element instead. \r\n\r\nExample RelatedPersons are: \r\n\r\n* A patient's wife or husband\r\n* A patient's relatives or friends\r\n* A neighbor bringing a patient to the hospital\r\n* The owner or trainer of a horse\r\n* A patient's attorney or guardian",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "RelatedPerson",
"publish": true,
"element": [
{
"path": "RelatedPerson",
"definition": {
"short": "An person that is related to a patient, but who is not a direct target of care",
"formal": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "role"
}
]
}
},
{
"path": "RelatedPerson.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "RelatedPerson.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "RelatedPerson.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "RelatedPerson.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "RelatedPerson.identifier",
"definition": {
"short": "A Human identifier for this person",
"formal": "Identifier for a person within a particular scope.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "NK1-33"
}
]
}
},
{
"path": "RelatedPerson.patient",
"definition": {
"short": "The patient this person is related to",
"formal": "The patient this person is related to.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"
},
{
"identity": "v2",
"map": "PID-3"
}
]
}
},
{
"path": "RelatedPerson.relationship",
"definition": {
"short": "The nature of the relationship",
"formal": "The nature of the relationship between a patient and the related person.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PatientRelationshipType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/relatedperson-relationshiptype"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "NK1-3"
}
]
}
},
{
"path": "RelatedPerson.name",
"definition": {
"short": "A name associated with the person",
"formal": "A name associated with the person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
},
{
"identity": "v2",
"map": "NK1-2"
}
]
}
},
{
"path": "RelatedPerson.telecom",
"definition": {
"short": "A contact detail for the person",
"formal": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "telecom"
},
{
"identity": "v2",
"map": "NK1-5 / NK1-6 / NK1-40"
}
]
}
},
{
"path": "RelatedPerson.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "administrativeGender"
},
{
"identity": "v2",
"map": "NK1-15"
}
]
}
},
{
"path": "RelatedPerson.address",
"definition": {
"short": "Address where the related person can be contacted or visited",
"formal": "Address where the related person can be contacted or visited.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "addr"
},
{
"identity": "v2",
"map": "NK1-4"
}
]
}
},
{
"path": "RelatedPerson.photo",
"definition": {
"short": "Image of the person",
"formal": "Image of the person.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc"
},
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "address",
"type": "string",
"documentation": "An address in any kind of address/part",
"xpath": "f:RelatedPerson/f:address"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the person",
"xpath": "f:RelatedPerson/f:gender"
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient Identifier",
"xpath": "f:RelatedPerson/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of name in any name part",
"xpath": "f:RelatedPerson/f:name"
},
{
"name": "patient",
"type": "reference",
"documentation": "The patient this person is related to",
"xpath": "f:RelatedPerson/f:patient"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "telecom",
"type": "string",
"documentation": "The value in any kind of contact",
"xpath": "f:RelatedPerson/f:telecom"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change