. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Profile for patient
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Demographics and other administrative information about a person or animal receiving care or other health-related services.\" class=\"dict\" href=\"patient-definitions.html#Patient\"><b>Patient</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"An identifier that applies to this person as a patient.\" class=\"dict\" href=\"patient-definitions.html#Patient.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">An identifier for the person as this patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.\" class=\"dict\" href=\"patient-definitions.html#Patient.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.html#Patient.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"The date and time of birth for the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.birthDate\"><b>birthDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The date and time of birth for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates if the individual is deceased or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.deceased_x_\"><span style=\"text-decoration: underline\"><b>deceased[x]</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#dateTime\">dateTime</a></span> <span style=\"color: navy\">Indicates if the individual is deceased or not<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></deceased[x]>\r\n <<a title=\"Addresses for the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Addresses for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"This field contains a patient's most recent marital (civil) status.\" class=\"dict\" href=\"patient-definitions.html#Patient.maritalStatus\"><b>maritalStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-marital-status.html\">Marital (civil) status of a person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></maritalStatus>\r\n <<a title=\"Indicates whether the patient is part of a multiple or indicates the actual birth order.\" class=\"dict\" href=\"patient-definitions.html#Patient.multipleBirth_x_\"><b>multipleBirth[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#integer\">integer</a></span> <span style=\"color: navy\">\r\n Whether patient is part of a multiple birth<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></multipleBirth[x]>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"patient-definitions.html#Patient.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n <<a title=\"A contact party (e.g. guardian, partner, friend) for the patient.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact\"><b>contact</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A contact party (e.g. guardian, partner, friend) for the patient --></span>\r\n <<a title=\"The nature of the relationship between the patient and the contact person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.relationship\"><b>relationship</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-patient-contact-relationship.html\">The kind of relationship</a></span><span style=\"color: Gray\"> --></span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person</span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the person</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Address for the contact person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Address for the contact person</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes</a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"Organization on behalf of which the contact is acting or for which the contact is working.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.organization\"><b>organization</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: SHALL at least contain a contact's details or a reference to an organization\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that is associated with the contact</span><span style=\"color: Gray\"> --></span></organization>\r\n </contact>\r\n <<a title=\"This element has a value if the patient is an animal (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.animal\"><span style=\"text-decoration: underline\"><b>animal</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this patient is an animal (non-human)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Identifies the high level categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.species\"><b>species</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-species.html\">E.g. Dog, Cow<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></species>\r\n <<a title=\"Identifies the detailed categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.breed\"><b>breed</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-breeds.html\">E.g. Poodle, Angus<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></breed>\r\n <<a title=\"Indicates the current state of the animal's reproductive organs.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.genderStatus\"><b>genderStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-genderstatus.html\">E.g. Neutered, Intact<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></genderStatus>\r\n </animal>\r\n <<a title=\"Languages which may be used to communicate with the patient about his or her health.\" class=\"dict\" href=\"patient-definitions.html#Patient.communication\"><b>communication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">Languages which may be used to communicate with the patient about his or her health</a></span><span style=\"color: Gray\"> --></span></communication>\r\n <<a title=\"Patient's nominated care provider.\" class=\"dict\" href=\"patient-definitions.html#Patient.careProvider\"><b>careProvider</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Patient's nominated care provider</span><span style=\"color: Gray\"> --></span></careProvider>\r\n <<a title=\"Organization that is the custodian of the patient record.\" class=\"dict\" href=\"patient-definitions.html#Patient.managingOrganization\"><b>managingOrganization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that is the custodian of the patient record<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></managingOrganization>\r\n <<a title=\"Link to another patient resource that concerns the same actual person (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link\"><span style=\"text-decoration: underline\"><b>link</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Link to another patient resource that concerns the same actual person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The other patient resource that the link refers to (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link.other\"><span style=\"text-decoration: underline\"><b>other</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">The other patient resource that the link refers to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></other>\r\n <<a title=\"The type of link between this patient resource and another patient resource (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link.type\"><span style=\"text-decoration: underline\"><b>type</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"link-type.html\">replace | refer | seealso - type of link<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n </link>\r\n <<a title=\"Whether this patient record is in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.active\"><span style=\"text-decoration: underline\"><b>active</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether this patient's record is in active use<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n</Patient>\r\n</pre></div>"
},
"name": "patient",
"publisher": "FHIR Project",
"description": "Basic Profile. Demographics and other administrative information about a person or animal receiving care or other health-related services.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This Resource covers data about persons and animals involved in a wide range of health-related activities, including: \r\n\r\n* Curative activities\r\n* Psychiatric care\r\n* Social services\r\n* Pregnancy care\r\n* Nursing and assisted living\r\n* Dietary services\r\n* Tracking of personal health and exercise data\r\nThe data in the Resource covers the \"who\" information about the patient: its attributes are focused on the demographic information necessary to support the administrative, financial and logistic procedures. A Patient record is generally created and maintained by each organization providing care for a patient. A person or animal receiving care at multiple organizations may therefore have its information present in multiple Patient Resources.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Patient",
"publish": true,
"element": [
{
"path": "Patient",
"definition": {
"short": "Information about a person or animal receiving health care services",
"formal": "Demographics and other administrative information about a person or animal receiving care or other health-related services.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Patient[classCode=PAT]"
}
]
}
},
{
"path": "Patient.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Patient.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Patient.identifier",
"definition": {
"short": "An identifier for the person as this patient",
"formal": "An identifier that applies to this person as a patient.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "PID-3"
}
]
}
},
{
"path": "Patient.name",
"definition": {
"short": "A name associated with the patient",
"formal": "A name associated with the individual.",
"comments": "Person may have multiple names with different uses or applicable periods.For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.",
"min": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
},
{
"identity": "v2",
"map": "PID-5, PID-9"
}
]
}
},
{
"path": "Patient.telecom",
"definition": {
"short": "A contact detail for the individual",
"formal": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "telecom"
},
{
"identity": "v2",
"map": "PID-13, PID-14, PID-40"
}
]
}
},
{
"path": "Patient.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"comments": "The gender may 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 the vast majority of systems and contexts only support M and F.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity": "v2",
"map": "PID-8"
}
]
}
},
{
"path": "Patient.birthDate",
"definition": {
"short": "The date and time of birth for the individual",
"formal": "The date and time of birth for the individual.",
"comments": "At least an estimated year should be provided as a guess if the real dob is unknown.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"
},
{
"identity": "v2",
"map": "PID-7"
}
]
}
},
{
"path": "Patient.deceased[x]",
"definition": {
"short": "Indicates if the individual is deceased or not",
"formal": "Indicates if the individual is deceased or not.",
"comments": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "dateTime"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd,\rplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"
},
{
"identity": "v2",
"map": "PID-30\r (bool) and PID-29 (datetime)"
}
]
}
},
{
"path": "Patient.address",
"definition": {
"short": "Addresses for the individual",
"formal": "Addresses for the individual.",
"comments": "Person may have multiple addresses with different uses or applicable periods.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "addr"
},
{
"identity": "v2",
"map": "PID-11"
}
]
}
},
{
"path": "Patient.maritalStatus",
"definition": {
"short": "Marital (civil) status of a person",
"formal": "This field contains a patient's most recent marital (civil) status.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MaritalStatus",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/marital-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN]/maritalStatusCode"
},
{
"identity": "v2",
"map": "PID-16"
}
]
}
},
{
"path": "Patient.multipleBirth[x]",
"definition": {
"short": "Whether patient is part of a multiple birth",
"formal": "Indicates whether the patient is part of a multiple or indicates the actual birth order.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, \rplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"
},
{
"identity": "v2",
"map": "PID-24 (bool), PID-25 (integer)"
}
]
}
},
{
"path": "Patient.photo",
"definition": {
"short": "Image of the person",
"formal": "Image of the person.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
},
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
}
]
}
},
{
"path": "Patient.contact",
"definition": {
"short": "A contact party (e.g. guardian, partner, friend) for the patient",
"formal": "A contact party (e.g. guardian, partner, friend) for the patient.",
"comments": "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "1",
"name": "ContactNeedsDetails",
"severity": "error",
"human": "SHALL at least contain a contact's details or a reference to an organization",
"xpath": "f:name or f:telecom or f:address or f:organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"
}
]
}
},
{
"path": "Patient.contact.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.contact.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.contact.relationship",
"definition": {
"short": "The kind of relationship",
"formal": "The nature of the relationship between the patient and the contact person.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ContactRelationship",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/patient-contact-relationship"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "NK1-7, NK1-3"
}
]
}
},
{
"path": "Patient.contact.name",
"definition": {
"short": "A name associated with the person",
"formal": "A name associated with the person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
},
{
"identity": "v2",
"map": "NK1-2"
}
]
}
},
{
"path": "Patient.contact.telecom",
"definition": {
"short": "A contact detail for the person",
"formal": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "telecom"
},
{
"identity": "v2",
"map": "NK1-5, NK1-6, NK1-40"
}
]
}
},
{
"path": "Patient.contact.address",
"definition": {
"short": "Address for the contact person",
"formal": "Address for the contact person.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "addr"
},
{
"identity": "v2",
"map": "NK1-4"
}
]
}
},
{
"path": "Patient.contact.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity": "v2",
"map": "NK1-15"
}
]
}
},
{
"path": "Patient.contact.organization",
"definition": {
"short": "Organization that is associated with the contact",
"formal": "Organization on behalf of which the contact is acting or for which the contact is working.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "scoper"
},
{
"identity": "v2",
"map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"
}
]
}
},
{
"path": "Patient.animal",
"definition": {
"short": "If this patient is an animal (non-human)",
"formal": "This element has a value if the patient is an animal.",
"comments": "The animal element is labeled \"Is Modifier\" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject non-human patient records.",
"min": 0,
"max": "1",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=ANM]"
}
]
}
},
{
"path": "Patient.animal.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.animal.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.animal.species",
"definition": {
"short": "E.g. Dog, Cow",
"formal": "Identifies the high level categorization of the kind of animal.",
"comments": "If the patient is non-human, at least a species SHALL be specified.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AnimalSpecies",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/animal-species"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "PID-35"
}
]
}
},
{
"path": "Patient.animal.breed",
"definition": {
"short": "E.g. Poodle, Angus",
"formal": "Identifies the detailed categorization of the kind of animal.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AnimalBreed",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/animal-breeds"
}
},
"mapping": [
{
"identity": "rim",
"map": "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"
},
{
"identity": "v2",
"map": "PID-37"
}
]
}
},
{
"path": "Patient.animal.genderStatus",
"definition": {
"short": "E.g. Neutered, Intact",
"formal": "Indicates the current state of the animal's reproductive organs.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AnimalGenderStatus",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/animal-genderstatus"
}
},
"mapping": [
{
"identity": "rim",
"map": "genderStatusCode"
},
{
"identity": "v2",
"map": "N/A"
}
]
}
},
{
"path": "Patient.communication",
"definition": {
"short": "Languages which may be used to communicate with the patient about his or her health",
"formal": "Languages which may be used to communicate with the patient about his or her health.",
"comments": "If no language is specified, this *implies* that the default local language is spoken.\rFor animals, language is not a relevant field, and should be absent from the instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Language",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
},
{
"identity": "v2",
"map": "LAN-2"
}
]
}
},
{
"path": "Patient.careProvider",
"definition": {
"short": "Patient's nominated care provider",
"formal": "Patient's nominated care provider.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "subjectOf.CareEvent.performer.AssignedEntity"
}
]
}
},
{
"path": "Patient.managingOrganization",
"definition": {
"short": "Organization that is the custodian of the patient record",
"formal": "Organization that is the custodian of the patient record.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "scoper"
}
]
}
},
{
"path": "Patient.link",
"definition": {
"short": "Link to another patient resource that concerns the same actual person",
"formal": "Link to another patient resource that concerns the same actual person.",
"comments": "There is no assumption that linked patient records have mutual links.",
"min": 0,
"max": "*",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "outboundLink"
}
]
}
},
{
"path": "Patient.link.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.link.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.link.other",
"definition": {
"short": "The other patient resource that the link refers to",
"formal": "The other patient resource that the link refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "PID-3, MRG-1"
}
]
}
},
{
"path": "Patient.link.type",
"definition": {
"short": "replace | refer | seealso - type of link",
"formal": "The type of link between this patient resource and another patient resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LinkType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/link-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "typeCode"
}
]
}
},
{
"path": "Patient.active",
"definition": {
"short": "Whether this patient's record is in active use",
"formal": "Whether this patient record is in active use.",
"comments": "Default is true. If a record is inactive, and linked to an active record, then future patient/person/record updates should occur on the other patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "active",
"type": "token",
"documentation": "Whether the patient record is active",
"xpath": "f:Patient/f:active"
},
{
"name": "address",
"type": "string",
"documentation": "An address in any kind of address/part of the patient",
"xpath": "f:Patient/f:address"
},
{
"name": "animal-breed",
"type": "token",
"documentation": "The breed for animal patients",
"xpath": "f:Patient/f:animal/f:breed"
},
{
"name": "animal-species",
"type": "token",
"documentation": "The species for animal patients",
"xpath": "f:Patient/f:animal/f:species"
},
{
"name": "birthdate",
"type": "date",
"documentation": "The patient's date of birth",
"xpath": "f:Patient/f:birthDate"
},
{
"name": "family",
"type": "string",
"documentation": "A portion of the family name of the patient",
"xpath": "f:Patient/f:name/f:family"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the patient",
"xpath": "f:Patient/f:gender"
},
{
"name": "given",
"type": "string",
"documentation": "A portion of the given name of the patient",
"xpath": "f:Patient/f:name/f:given"
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient identifier",
"xpath": "f:Patient/f:identifier"
},
{
"name": "language",
"type": "token",
"documentation": "Language code (irrespective of use value)",
"xpath": "f:Patient/f:communication"
},
{
"name": "link",
"type": "reference",
"documentation": "All patients linked to the given patient",
"xpath": "f:Patient/f:link/f:other"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of either family or given name of the patient",
"xpath": "f:Patient/f:name"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "provider",
"type": "reference",
"documentation": "The organization at which this person is a patient",
"xpath": "f:Patient/f:managingOrganization"
},
{
"name": "telecom",
"type": "string",
"documentation": "The value in any kind of telecom details of the patient",
"xpath": "f:Patient/f:telecom"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change