{
"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.",
"_filename": "StructureDefinition-Relatedperson-my-core.json",
"package_name": "hie2.packages",
"date": "2022-03-11T00:00:00+08:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2022-03-19T07:16:10.884+00:00"
},
"publisher": "Malaysia MOH - HIE Steering Committee",
"fhirVersion": "4.0.1",
"purpose": "Need to track persons related to the patient or the healthcare process.",
"name": "RelatedPersonMyCore",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://fhir.hie.moh.gov.my/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "RelatedPerson",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "RelatedPerson (MY Core)",
"package_version": "1.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Base.Individuals"
}, {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}, {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/structuredefinition-security-category",
"valueCode": "patient"
}, {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/structuredefinition-wg",
"valueCode": "pa"
} ],
"status": "active",
"id": "d3b68c01-a554-4dbf-9507-fe961754e879",
"kind": "resource",
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/RelatedPerson-my-core",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "RelatedPerson",
"path": "RelatedPerson",
"short": "A person that is related to a patient, but who is not a direct target of care",
"mapping": [ {
"map": "role",
"identity": "rim"
} ],
"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."
}, {
"id": "RelatedPerson.identifier",
"path": "RelatedPerson.identifier",
"short": "A human identifier for this person",
"mapping": [ {
"map": "NK1-33",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"definition": "Identifier for a person within a particular scope.",
"mustSupport": true,
"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."
}, {
"id": "RelatedPerson.active",
"path": "RelatedPerson.active",
"short": "Whether this related person's 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.",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
} ],
"definition": "Whether this related person record is in active use.",
"requirements": "Need to be able to mark a related person record as not to be used, such as if it was created in error."
}, {
"id": "RelatedPerson.name",
"min": 1,
"path": "RelatedPerson.name",
"short": "A name associated with the person",
"mapping": [ {
"map": "NK1-2",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
} ],
"definition": "A name associated with the person.",
"mustSupport": true,
"requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person."
}, {
"id": "RelatedPerson.telecom",
"path": "RelatedPerson.telecom",
"short": "A contact detail for the person",
"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.",
"mapping": [ {
"map": "NK1-5 / NK1-6 / NK1-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
} ],
"isSummary": true,
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email."
}, {
"id": "RelatedPerson.address",
"path": "RelatedPerson.address",
"type": [ {
"code": "Address",
"profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/Address-my-core" ]
} ],
"short": "Address where the related person can be contacted or visited",
"mapping": [ {
"map": "NK1-4",
"identity": "v2"
}, {
"map": "addr",
"identity": "rim"
} ],
"isSummary": true,
"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."
}, {
"id": "RelatedPerson.partOf",
"path": "RelatedPerson.partOf",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/Organization-my-core" ]
} ]
}, {
"path": "RelatedPerson.patient",
"requirements": "We need to know which patient this RelatedPerson is related to.",
"min": 1,
"definition": "The patient this person is related to.",
"short": "The patient this person is related to",
"mapping": [ {
"map": "PID-3",
"identity": "v2"
}, {
"map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/Patient-my-core" ]
} ],
"mustSupport": true,
"max": "1",
"id": "RelatedPerson.patient",
"isSummary": true
}, {
"path": "RelatedPerson.relationship",
"requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
"definition": "The nature of the relationship between a patient and the related person.",
"short": "The nature of the relationship",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype",
"extension": [ {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/elementdefinition-bindingName",
"valueString": "PatientRelationshipType"
} ],
"description": "The nature of the relationship between a patient and the related person."
},
"id": "RelatedPerson.relationship",
"isSummary": true
}, {
"path": "RelatedPerson.gender",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date.",
"definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"short": "male | female | other | unknown",
"mapping": [ {
"map": "NK1-15",
"identity": "v2"
}, {
"map": "administrativeGender",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1",
"extension": [ {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
}, {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The gender of a person used for administrative purposes."
},
"max": "1",
"id": "RelatedPerson.gender",
"isSummary": true
}, {
"id": "RelatedPerson.birthDate",
"max": "1",
"path": "RelatedPerson.birthDate",
"type": [ {
"code": "date"
} ],
"short": "The date on which the related person was born",
"mapping": [ {
"map": "player.birthTime",
"identity": "rim"
} ],
"isSummary": true,
"definition": "The date on which the related person was born."
}, {
"id": "RelatedPerson.photo",
"path": "RelatedPerson.photo",
"type": [ {
"code": "Attachment"
} ],
"short": "Image of the person",
"mapping": [ {
"map": "OBX-5 - needs a profile",
"identity": "v2"
}, {
"map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc",
"identity": "rim"
} ],
"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."
}, {
"id": "RelatedPerson.period",
"max": "1",
"path": "RelatedPerson.period",
"type": [ {
"code": "Period"
} ],
"short": "Period of time that this relationship is considered valid",
"mapping": [ {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown."
}, {
"id": "RelatedPerson.communication",
"path": "RelatedPerson.communication",
"type": [ {
"code": "BackboneElement"
} ],
"short": "A language which may be used to communicate with 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.",
"mapping": [ {
"map": "LanguageCommunication",
"identity": "rim"
} ],
"definition": "A language which may be used to communicate with about the patient's health.",
"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."
}, {
"path": "RelatedPerson.communication.language",
"requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min": 1,
"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.",
"short": "The language which can be used to communicate with the patient about his or her health",
"mapping": [ {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://fhir.hie.moh.gov.my/ValueSet/languages",
"extension": [ {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://fhir.hie.moh.gov.my/ValueSet/all-languages"
}, {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://fhir.hie.moh.gov.my/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "RelatedPerson.communication.language",
"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."
}, {
"path": "RelatedPerson.communication.preferred",
"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.",
"definition": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"short": "Language preference indicator",
"mapping": [ {
"map": "preferenceInd",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "RelatedPerson.communication.preferred",
"comment": "This language is specifically identified for communicating healthcare information."
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization"
}