{
"description": "Profile of RelatedPerson for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.",
"_filename": "StructureDefinition-qicore-relatedperson.json",
"package_name": "hl7.fhir.us.qicore",
"date": "2018-08-22T00:00:00+10:00",
"derivation": "constraint",
"publisher": "Health Level Seven, Inc. - CQI WG",
"fhirVersion": "3.0.1",
"name": "QICore-RelatedPerson",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "RelatedPerson",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "3.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "RelatedPerson",
"min": 0,
"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.",
"short": "An person that is related to a patient, but who is not a direct target of care",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "role",
"identity": "rim"
}, {
"map": "administrative.individual",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "RelatedPerson",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson"
}
}, {
"path": "RelatedPerson.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "RelatedPerson.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "RelatedPerson.meta",
"min": 0,
"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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "RelatedPerson.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "RelatedPerson.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "RelatedPerson.implicitRules",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "RelatedPerson.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "RelatedPerson.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "RelatedPerson.text",
"min": 0,
"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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "RelatedPerson.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "RelatedPerson.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "RelatedPerson.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "RelatedPerson.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RelatedPerson.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "RelatedPerson.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RelatedPerson.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "RelatedPerson.identifier",
"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,
"definition": "Identifier for a person within a particular scope.",
"short": "A human identifier for this person",
"mapping": [ {
"map": "NK1-33",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "RelatedPerson.identifier",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.identifier"
},
"isSummary": true
}, {
"path": "RelatedPerson.active",
"requirements": "Need to be able to mark a related person record as not to be used, such as if it was created in error.",
"min": 0,
"definition": "Whether this related person record is in active use.",
"isModifier": true,
"short": "Whether this related person's record is in active use",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": true,
"max": "1",
"id": "RelatedPerson.active",
"comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.active"
},
"isSummary": true
}, {
"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://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
} ],
"mustSupport": true,
"max": "1",
"id": "RelatedPerson.patient",
"base": {
"max": "1",
"min": 1,
"path": "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.",
"min": 0,
"definition": "The nature of the relationship between a patient and the related person.",
"short": "The nature of the relationship",
"mapping": [ {
"map": "NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "preferred",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PatientRelationshipType"
} ],
"description": "The nature of the relationship between a patient and the related person",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"
}
},
"max": "1",
"id": "RelatedPerson.relationship",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.relationship"
},
"isSummary": true
}, {
"path": "RelatedPerson.name",
"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,
"definition": "A name associated with the person.",
"short": "A name associated with the person",
"mapping": [ {
"map": "NK1-2",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
} ],
"type": [ {
"code": "HumanName"
} ],
"max": "*",
"id": "RelatedPerson.name",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.name"
},
"isSummary": true
}, {
"path": "RelatedPerson.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"short": "A contact detail for the person",
"mapping": [ {
"map": "NK1-5 / NK1-6 / NK1-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "RelatedPerson.telecom",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.telecom"
},
"isSummary": true
}, {
"path": "RelatedPerson.gender",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date.",
"min": 0,
"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",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"max": "1",
"id": "RelatedPerson.gender",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.gender"
},
"isSummary": true
}, {
"path": "RelatedPerson.birthDate",
"min": 0,
"definition": "The date on which the related person was born.",
"short": "The date on which the related person was born",
"mapping": [ {
"map": "player.birthTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "RelatedPerson.birthDate",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.birthDate"
},
"isSummary": true
}, {
"path": "RelatedPerson.address",
"requirements": "Need to keep track where the related person can be contacted per postal mail or visited.",
"min": 0,
"definition": "Address where the related person can be contacted or visited.",
"short": "Address where the related person can be contacted or visited",
"mapping": [ {
"map": "NK1-4",
"identity": "v2"
}, {
"map": "addr",
"identity": "rim"
} ],
"type": [ {
"code": "Address"
} ],
"max": "*",
"id": "RelatedPerson.address",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.address"
},
"isSummary": true
}, {
"path": "RelatedPerson.photo",
"requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.",
"min": 0,
"definition": "Image of the person.",
"short": "Image of the person",
"mapping": [ {
"map": "OBX-5 - needs a profile",
"identity": "v2"
}, {
"map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "*",
"id": "RelatedPerson.photo",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.photo"
}
}, {
"path": "RelatedPerson.period",
"min": 0,
"definition": "The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.",
"short": "Period of time that this relationship is considered valid",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": true,
"max": "1",
"id": "RelatedPerson.period",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.period"
}
} ]
},
"status": "draft",
"id": "27ea4b1b-1c7e-44c8-b738-3f439d669f19",
"kind": "resource",
"url": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson",
"version": "3.1.0",
"differential": {
"element": [ {
"id": "RelatedPerson",
"path": "RelatedPerson",
"isModifier": false,
"mustSupport": false
}, {
"id": "RelatedPerson.patient",
"path": "RelatedPerson.patient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
} ],
"isModifier": false,
"mustSupport": true
}, {
"id": "RelatedPerson.relationship",
"path": "RelatedPerson.relationship",
"isModifier": false,
"mustSupport": true
}, {
"id": "RelatedPerson.gender",
"path": "RelatedPerson.gender",
"isModifier": false,
"mustSupport": true
}, {
"id": "RelatedPerson.period",
"path": "RelatedPerson.period",
"isModifier": false,
"mustSupport": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/CQI",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}