{
"description": "Demographics and administrative information about a person independent of a specific health-related context.",
"_filename": "StructureDefinition-Person.json",
"package_name": "hl7.fhir.r6.core",
"date": "2025-04-01T12:16:37+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2025-04-01T12:16:37.966+11:00"
},
"publisher": "HL7 International / Patient Administration",
"fhirVersion": "6.0.0-ballot3",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "Need to track persons potentially across multiple roles.",
"name": "Person",
"mapping": [ {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Person",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Base.Individuals"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pa"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "patient"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "Person",
"min": 0,
"definition": "Demographics and administrative information about a person independent of a specific health-related context.",
"isModifier": false,
"short": "A generic person record",
"mapping": [ {
"map": "Entity, Role, or Act,Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")",
"identity": "rim"
}, {
"map": "administrative.entity",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "Person",
"comment": "The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).",
"base": {
"max": "*",
"min": 0,
"path": "Person"
},
"isSummary": false
}, {
"path": "Person.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "Person.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "Person.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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can 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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Person.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a 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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Person.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Person.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](resource.html#additional).",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Person.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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Person.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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.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 person. Examples are national person identifier and local identifier.",
"min": 0,
"definition": "Identifier for a person within a particular scope.",
"isModifier": false,
"short": "A human identifier for this person",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": ".plays:Role(classCode='IDENT').id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.identifier",
"comment": "Systems MAY use identifier for user identities (using the type='USER'). Refer to the [Security and Privacy](administration-module.html#secpriv) section for additional guidance on representing user identities, particularly where duplicating the identifier to other resources.",
"base": {
"max": "*",
"min": 0,
"path": "Person.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.active",
"requirements": "Need to be able to mark a person record as not to be used because it was created in error.",
"min": 0,
"definition": "Whether this person's record is in active use.",
"isModifier": true,
"short": "This person's record is in active use",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.active",
"base": {
"max": "1",
"min": 0,
"path": "Person.active"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.name",
"requirements": "Need to be able to track the person by multiple names. Examples are your official name and a partner name.",
"min": 0,
"definition": "A name associated with the person.",
"isModifier": false,
"short": "A name associated with the person",
"mapping": [ {
"map": "PID-5, PID-9",
"identity": "v2"
}, {
"map": "./name",
"identity": "rim"
} ],
"type": [ {
"code": "HumanName"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.name",
"comment": "Person may have multiple names with different uses or applicable periods.",
"base": {
"max": "*",
"min": 0,
"path": "Person.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.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.",
"isModifier": false,
"short": "A contact detail for the person",
"mapping": [ {
"map": "PID-13, PID-14",
"identity": "v2"
}, {
"map": "./telecom",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.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.\r\rDO NOT use .telecom properties to represent user identities. Refer to the [Security and Privacy](administration-module.html#secpriv) section for additional guidance on representing user identities.",
"base": {
"max": "*",
"min": 0,
"path": "Person.telecom"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.gender",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.",
"min": 0,
"definition": "Administrative Gender.",
"isModifier": false,
"short": "male | female | other | unknown",
"mapping": [ {
"map": "PID-8",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|6.0.0-ballot3",
"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."
},
"max": "1",
"id": "Person.gender",
"comment": "The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.",
"base": {
"max": "1",
"min": 0,
"path": "Person.gender"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.birthDate",
"requirements": "Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.",
"min": 0,
"definition": "The birth date for the person.",
"isModifier": false,
"short": "The date on which the person was born",
"mapping": [ {
"map": "PID-7",
"identity": "v2"
}, {
"map": "./birthTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.birthDate",
"comment": "At least an estimated year should be provided as a guess if the real DOB is unknown.",
"base": {
"max": "1",
"min": 0,
"path": "Person.birthDate"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.deceased[x]",
"min": 0,
"definition": "Indicates if the individual is deceased or not.",
"isModifier": false,
"short": "Indicates if the individual is deceased or not",
"mapping": [ {
"map": "PID-30 (bool) and PID-29 (datetime)",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.deceased[x]",
"comment": "If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.",
"base": {
"max": "1",
"min": 0,
"path": "Person.deceased[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.address",
"requirements": "May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"definition": "One or more addresses for the person.",
"isModifier": false,
"short": "One or more addresses for the person",
"mapping": [ {
"map": "PID-11",
"identity": "v2"
}, {
"map": "./addr",
"identity": "rim"
} ],
"type": [ {
"code": "Address"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.address",
"comment": "Person may have multiple addresses with different uses or applicable periods.",
"base": {
"max": "*",
"min": 0,
"path": "Person.address"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.maritalStatus",
"min": 0,
"definition": "This field contains a person's most recent marital (civil) status.",
"isModifier": false,
"short": "Marital (civil) status of a person",
"mapping": [ {
"map": "PID-16",
"identity": "v2"
}, {
"map": "player[classCode=PSN]/maritalStatusCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/marital-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MaritalStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The domestic partnership status of a person."
},
"max": "1",
"id": "Person.maritalStatus",
"comment": "Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction",
"base": {
"max": "1",
"min": 0,
"path": "Person.maritalStatus"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.photo",
"min": 0,
"definition": "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.",
"isModifier": false,
"short": "Image of the person",
"mapping": [ {
"map": "OBX-5 - needs a profile",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.photo",
"base": {
"max": "*",
"min": 0,
"path": "Person.photo"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.communication",
"requirements": "If a person does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for person and other persons of interest.",
"min": 0,
"definition": "A language which may be used to communicate with the person about his or her health.",
"isModifier": false,
"short": "A language which may be used to communicate with the person about his or her health",
"mapping": [ {
"map": "LanguageCommunication",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.communication",
"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 Person.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.\n\nNote that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission)",
"base": {
"max": "*",
"min": 0,
"path": "Person.communication"
},
"isSummary": false
}, {
"path": "Person.communication.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Person.communication.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.communication.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Person.communication.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": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.communication.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Person.communication.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": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.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 language which may be used to communicate with the individual.",
"isModifier": false,
"short": "The language which can be used to communicate with the person about his or her health",
"mapping": [ {
"map": "PID-15, LAN-2",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "Person.communication.language",
"comment": "The language is commonly represented using the ISO-639-1 alpha code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha code for the region in upper case. For example, \"en\" for English, or \"en-US\" for American English versus \"en-AU\" for Australian English, sgn-US for American Sign Language, sgn-NL for Dutch Sign Language, etc.\r\rNot all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"base": {
"max": "1",
"min": 1,
"path": "Person.communication.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.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.",
"min": 0,
"definition": "Indicates whether or not the person prefers this language (over other languages he masters up a certain level).",
"isModifier": false,
"short": "Language preference indicator",
"mapping": [ {
"map": "PID-15",
"identity": "v2"
}, {
"map": "preferenceInd",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.communication.preferred",
"comment": "This language is specifically identified for communicating healthcare information.",
"base": {
"max": "1",
"min": 0,
"path": "Person.communication.preferred"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.managingOrganization",
"requirements": "Need to know who recognizes this person record, manages and updates it.",
"min": 0,
"definition": "The organization that is the custodian of the person record.",
"isModifier": false,
"short": "The organization that is the custodian of the person record",
"mapping": [ {
"map": "scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Person.managingOrganization",
"base": {
"max": "1",
"min": 0,
"path": "Person.managingOrganization"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.link",
"min": 0,
"definition": "Link to a resource that concerns the same actual person.",
"isModifier": false,
"short": "Link to a resource that concerns the same actual person",
"mapping": [ {
"map": "outboundLink",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.link",
"base": {
"max": "*",
"min": 0,
"path": "Person.link"
},
"isSummary": false
}, {
"path": "Person.link.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Person.link.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.link.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Person.link.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": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.link.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Person.link.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": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.link.target",
"min": 1,
"definition": "The resource to which this actual person is associated.",
"isModifier": false,
"short": "The resource to which this actual person is associated",
"mapping": [ {
"map": "id",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": false
} ],
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Person" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Person.link.target",
"base": {
"max": "1",
"min": 1,
"path": "Person.link.target"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Person.link.assurance",
"min": 0,
"definition": "Level of assurance that this link is associated with the target resource.",
"isModifier": false,
"short": "level1 | level2 | level3 | level4",
"mapping": [ {
"map": "priorityNumber?",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identity-assuranceLevel|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentityAssuranceLevel"
} ],
"description": "The level of confidence that this link represents the same actual person, based on NIST Authentication Levels."
},
"max": "1",
"id": "Person.link.assurance",
"base": {
"max": "1",
"min": 0,
"path": "Person.link.assurance"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "329afff2-d226-4cbd-9d53-bda5716218e3",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/Person",
"version": "6.0.0-ballot3",
"differential": {
"element": [ {
"path": "Person",
"min": 0,
"definition": "Demographics and administrative information about a person independent of a specific health-related context.",
"isModifier": false,
"short": "A generic person record",
"mapping": [ {
"map": "administrative.entity",
"identity": "w5"
}, {
"map": "Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")",
"identity": "rim"
} ],
"mustSupport": false,
"max": "*",
"id": "Person",
"comment": "The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare)."
}, {
"path": "Person.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 person. Examples are national person identifier and local identifier.",
"min": 0,
"definition": "Identifier for a person within a particular scope.",
"isModifier": false,
"short": "A human identifier for this person",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": ".plays:Role(classCode='IDENT').id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.identifier",
"comment": "Systems MAY use identifier for user identities (using the type='USER'). Refer to the [Security and Privacy](administration-module.html#secpriv) section for additional guidance on representing user identities, particularly where duplicating the identifier to other resources.",
"isSummary": true
}, {
"path": "Person.active",
"requirements": "Need to be able to mark a person record as not to be used because it was created in error.",
"min": 0,
"definition": "Whether this person's record is in active use.",
"isModifier": true,
"short": "This person's record is in active use",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.active",
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary": true
}, {
"path": "Person.name",
"requirements": "Need to be able to track the person by multiple names. Examples are your official name and a partner name.",
"min": 0,
"definition": "A name associated with the person.",
"isModifier": false,
"short": "A name associated with the person",
"mapping": [ {
"map": "PID-5, PID-9",
"identity": "v2"
}, {
"map": "./name",
"identity": "rim"
} ],
"type": [ {
"code": "HumanName"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.name",
"comment": "Person may have multiple names with different uses or applicable periods.",
"isSummary": true
}, {
"path": "Person.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.",
"isModifier": false,
"short": "A contact detail for the person",
"mapping": [ {
"map": "PID-13, PID-14",
"identity": "v2"
}, {
"map": "./telecom",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.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.\r\rDO NOT use .telecom properties to represent user identities. Refer to the [Security and Privacy](administration-module.html#secpriv) section for additional guidance on representing user identities.",
"isSummary": true
}, {
"path": "Person.gender",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.",
"min": 0,
"definition": "Administrative Gender.",
"isModifier": false,
"short": "male | female | other | unknown",
"mapping": [ {
"map": "PID-8",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|6.0.0-ballot3",
"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."
},
"max": "1",
"id": "Person.gender",
"comment": "The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.",
"isSummary": true
}, {
"path": "Person.birthDate",
"requirements": "Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.",
"min": 0,
"definition": "The birth date for the person.",
"isModifier": false,
"short": "The date on which the person was born",
"mapping": [ {
"map": "PID-7",
"identity": "v2"
}, {
"map": "./birthTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.birthDate",
"comment": "At least an estimated year should be provided as a guess if the real DOB is unknown.",
"isSummary": true
}, {
"path": "Person.deceased[x]",
"min": 0,
"definition": "Indicates if the individual is deceased or not.",
"isModifier": false,
"short": "Indicates if the individual is deceased or not",
"mapping": [ {
"map": "PID-30 (bool) and PID-29 (datetime)",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.deceased[x]",
"comment": "If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.",
"isSummary": true
}, {
"path": "Person.address",
"requirements": "May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"definition": "One or more addresses for the person.",
"isModifier": false,
"short": "One or more addresses for the person",
"mapping": [ {
"map": "PID-11",
"identity": "v2"
}, {
"map": "./addr",
"identity": "rim"
} ],
"type": [ {
"code": "Address"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.address",
"comment": "Person may have multiple addresses with different uses or applicable periods.",
"isSummary": true
}, {
"path": "Person.maritalStatus",
"min": 0,
"definition": "This field contains a person's most recent marital (civil) status.",
"isModifier": false,
"short": "Marital (civil) status of a person",
"mapping": [ {
"map": "PID-16",
"identity": "v2"
}, {
"map": "player[classCode=PSN]/maritalStatusCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/marital-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MaritalStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The domestic partnership status of a person."
},
"max": "1",
"id": "Person.maritalStatus",
"comment": "Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction",
"isSummary": false
}, {
"path": "Person.photo",
"min": 0,
"definition": "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.",
"isModifier": false,
"short": "Image of the person",
"mapping": [ {
"map": "OBX-5 - needs a profile",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.photo",
"isSummary": false
}, {
"path": "Person.communication",
"requirements": "If a person does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for person and other persons of interest.",
"min": 0,
"definition": "A language which may be used to communicate with the person about his or her health.",
"isModifier": false,
"short": "A language which may be used to communicate with the person about his or her health",
"mapping": [ {
"map": "LanguageCommunication",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.communication",
"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 Person.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.\n\nNote that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission)",
"isSummary": false
}, {
"path": "Person.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 language which may be used to communicate with the individual.",
"isModifier": false,
"short": "The language which can be used to communicate with the person about his or her health",
"mapping": [ {
"map": "PID-15, LAN-2",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "Person.communication.language",
"comment": "The language is commonly represented using the ISO-639-1 alpha code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha code for the region in upper case. For example, \"en\" for English, or \"en-US\" for American English versus \"en-AU\" for Australian English, sgn-US for American Sign Language, sgn-NL for Dutch Sign Language, etc.\r\rNot all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"isSummary": false
}, {
"path": "Person.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.",
"min": 0,
"definition": "Indicates whether or not the person prefers this language (over other languages he masters up a certain level).",
"isModifier": false,
"short": "Language preference indicator",
"mapping": [ {
"map": "PID-15",
"identity": "v2"
}, {
"map": "preferenceInd",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "Person.communication.preferred",
"comment": "This language is specifically identified for communicating healthcare information.",
"isSummary": false
}, {
"path": "Person.managingOrganization",
"requirements": "Need to know who recognizes this person record, manages and updates it.",
"min": 0,
"definition": "The organization that is the custodian of the person record.",
"isModifier": false,
"short": "The organization that is the custodian of the person record",
"mapping": [ {
"map": "scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Person.managingOrganization",
"isSummary": true
}, {
"path": "Person.link",
"min": 0,
"definition": "Link to a resource that concerns the same actual person.",
"isModifier": false,
"short": "Link to a resource that concerns the same actual person",
"mapping": [ {
"map": "outboundLink",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Person.link",
"isSummary": false
}, {
"path": "Person.link.target",
"min": 1,
"definition": "The resource to which this actual person is associated.",
"isModifier": false,
"short": "The resource to which this actual person is associated",
"mapping": [ {
"map": "id",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": false
} ],
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Person" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Person.link.target",
"isSummary": false
}, {
"path": "Person.link.assurance",
"min": 0,
"definition": "Level of assurance that this link is associated with the target resource.",
"isModifier": false,
"short": "level1 | level2 | level3 | level4",
"mapping": [ {
"map": "priorityNumber?",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identity-assuranceLevel|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentityAssuranceLevel"
} ],
"description": "The level of confidence that this link represents the same actual person, based on NIST Authentication Levels."
},
"max": "1",
"id": "Person.link.assurance",
"isSummary": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/pafm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}