DSTU2
This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
(v1.0.2:
DSTU
1).
2).
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
StructureDefinition
for
relatedperson
{
"resourceType": "Profile",
"resourceType": "StructureDefinition",
"id": "RelatedPerson",
"meta": {
"lastUpdated": "2015-10-24T07:41:03.495+11:00"
},
"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>"
"div": "<div>!-- Snipped for Brevity --></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.",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"name": "RelatedPerson",
"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",
"publisher": "Health Level Seven International (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"date": "2015-10-24T07:41:03+11:00",
"description": "Base StructureDefinition for RelatedPerson Resource",
"requirements": "Need to track persons related to the patient or the healthcare process.",
"fhirVersion": "1.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"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"
}
]
"kind": "resource",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
},
{
"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
],
"mapping": [
{
"identity": "rim",
"map": "role"
},
{
"identity": "w5",
"map": "administrative.individual"
}
},
{
"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.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. 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.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
],
"isSummary": true
},
{
"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.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
],
"isSummary": true
},
{
"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"
}
},
{
"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"
}
]
],
"isModifier": true,
"isSummary": 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 Not 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"
}
},
{
"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"
}
]
],
"binding": {
"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"
}
},
{
"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"
}
]
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
},
{
"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.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"
}
},
{
"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"
}
]
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
},
{
"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.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"
},
{
"identity": "w5",
"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": {
"strength": "required",
"description": "The nature of the relationship between a patient and the related person",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"
}
},
{
"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"
}
]
"mapping": [
{
"identity": "v2",
"map": "NK1-3"
},
{
"identity": "rim",
"map": "code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"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. 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"
}
]
},
{
"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": {
"strength": "required",
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
{
"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"
}
"mapping": [
{
"identity": "v2",
"map": "NK1-15"
},
{
"identity": "rim",
"map": "administrativeGender"
}
]
},
{
"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
},
{
"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"
}
]
},
{
"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"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.done"
}
]
}
]
},
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "role"
},
{
"identity": "w5",
"map": "administrative.individual"
}
]
},
{
"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"
},
{
"identity": "w5",
"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"
]
}
}
],
"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"
],
"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": {
"strength": "required",
"description": "The nature of the relationship between a patient and the related person",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"
}
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
"mapping": [
{
"identity": "v2",
"map": "NK1-3"
},
{
"identity": "rim",
"map": "code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"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. 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"
}
]
},
{
"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": {
"strength": "required",
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
{
"name": "telecom",
"type": "string",
"documentation": "The value in any kind of contact",
"xpath": "f:RelatedPerson/f:telecom"
}
]
}
]
"mapping": [
{
"identity": "v2",
"map": "NK1-15"
},
{
"identity": "rim",
"map": "administrativeGender"
}
]
},
{
"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
},
{
"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"
}
]
},
{
"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"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.done"
}
]
}
]
}
}
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.
©
©
HL7.org
2011+.
FHIR
DSTU
(v0.0.82.2943)
DSTU2
(v1.0.2-7202)
generated
on
Tue,
Sep
30,
2014
18:10+1000.
Sat,
Oct
24,
2015
07:44+1100.
Links:
What's
a
DSTU?
Search
|
Version
History
|
Table
of
Contents
|
Compare
to
DSTU1
|
|
Propose
a
change