IL Core Implementation Guide
0.18.0 - draft
IL Core Implementation Guide
0.18.0 - draft
This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 1 |
Definitions for the il-core-patient resource profile.
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |
| Definition | The Patient Profile is based upon the core FHIR Patient Resource |
| Short | ILCore Patient profile |
| 2. Patient.extension | |
| Slicing | This element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Patient.extension:hmo | |
| Slice Name | hmo |
| Definition | A code classifying the person's Israeli HMO |
| Short | Extension: Israel Core HMO (קופת חולים) |
| Control | 0..1 |
| Type | Extension(Ext: Israel Health Management Organization (קופת חולים)) (Extension Type: CodeableConcept) |
| Must Support | true |
| 6. Patient.extension:parentName | |
| Slice Name | parentName |
| Definition | Extension: The name of a person’s parent, recorded for administrative purposes as part of the person’s demographics (e.g to help with identification). This SHOULD NOT be confused with a parent whose details are recorded for contact purposes (Patient.contact) or as a family member (RelatedPerson). Most systems will use the “father’s name” field as the source of data for this extension. NOTE: This extension replaces the old ParentName extension and is the PREFFERED extension |
| Short | Extension: Administrative Parent Name |
| Control | 0..* |
| Type | Extension(Ext: Administrative Parent Name) (Complex Extension) |
| Must Support | true |
| 8. Patient.extension:birthPlace | |
| Slice Name | birthPlace |
| Definition | The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements |
| Short | Extension: Place of Birth for patient |
| Control | 0..1 |
| Type | Extension(Patient Birth Place) (Extension Type: Address) |
| 10. Patient.extension:immigration | |
| Slice Name | immigration |
| Definition | Extension: Immigration information for a patient - for the purpose of this extension - immigration is an international movement of a person to a destination country in order to settle as permanent resident |
| Short | Extension: Patient Immigration |
| Control | 0..* |
| Type | Extension(Ext: Patient Immigration) (Complex Extension) |
| 12. Patient.extension:birthSex | |
| Slice Name | birthSex |
| Definition | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9). |
| Short | Extension: US Core Birth Sex Extension |
| Control | 0..1 |
| Type | Extension(US Core Birth Sex Extension) (Extension Type: code) |
| 14. Patient.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| Slicing | This element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Patient.identifier.system | |
| Control | 1..? |
| Must Support | true |
| 18. Patient.identifier.value | |
| Short | The value that is unique within the system. |
| Control | 1..? |
| Must Support | true |
| 20. Patient.identifier:il-id | |
| Slice Name | il-id |
| Definition | Israeli ID number (9 digit unchangeable number, including leading zeros and includes a control digit), including temporarily identification numbers assigned by Israeli National Insurance |
| Short | Israeli National Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Must Support | true |
| 22. Patient.identifier:il-id.system | |
| Fixed Value | http://fhir.health.gov.il/identifier/il-national-id |
| 24. Patient.identifier:il-id.value | |
| Short | An Israeli ID number |
| Example | <br/><b>Valid Example</b>:000000018 |
| Invariants | il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end. (matches('[0-9]{9}$') and
substring(8,1).toInteger()=
(10-((substring(0,1).toInteger() +
substring(1,1).toInteger()*2 mod 10 +
substring(1,1).toInteger()*2 div 10 +
substring(2,1).toInteger() +
substring(3,1).toInteger()*2 mod 10 +
substring(3,1).toInteger()*2 div 10 +
substring(4,1).toInteger() +
substring(5,1).toInteger()*2 mod 10 +
substring(5,1).toInteger()*2 div 10 +
substring(6,1).toInteger() +
substring(7,1).toInteger()*2 mod 10 +
substring(7,1).toInteger()*2 div 10) mod 10)) mod 10) |
| 26. Patient.identifier:il-id.assigner | |
| Type | Reference(ILCore Organization Profile) |
| 28. Patient.identifier:pna-id | |
| Slice Name | pna-id |
| Definition | Palestinian ID number |
| Short | Palestinian National Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Must Support | false |
| 30. Patient.identifier:pna-id.system | |
| Fixed Value | http://fhir.health.gov.il/identifier/pna-national-id |
| 32. Patient.identifier:pna-id.value | |
| Short | A Palestininan ID number |
| Example | <br/><b>Valid Example</b>:000000018 |
| 34. Patient.identifier:ppn | |
| Slice Name | ppn |
| Definition | Passport number |
| Short | Passport Number |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Must Support | false |
| 36. Patient.identifier:ppn.type | |
| Pattern Value | { |
| 38. Patient.identifier:ppn.system | |
| Binding | The codes SHALL be taken from Passport URIs (required to http://fhir.health.gov.il/ValueSet/passport-uri) |
| 40. Patient.identifier:ppn.value | |
| Short | Passport Number |
| 42. Patient.identifier:prisoner-id | |
| Slice Name | prisoner-id |
| Definition | Israel Prison Service prisoner number (5-6 digits number). A unique identifier for any prisoner currently serving a prison sentence |
| Short | Prisoner Number |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Must Support | true |
| 44. Patient.identifier:prisoner-id.system | |
| Fixed Value | http://fhir.health.gov.il/identifier/il-prisoner-number |
| 46. Patient.identifier:prisoner-id.value | |
| Short | Prisoner Number |
| Example | <br/><b>Valid Example</b>:123456 |
| Invariants | il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters (matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')) |
| 48. Patient.identifier:prisoner-id.assigner | |
| Type | Reference(ILCore Organization Profile) |
| 50. Patient.identifier:enc | |
| Slice Name | enc |
| Definition | The person’s identifier after applying MoH’s standard primary encryption algorithm |
| Short | Person's Identifier - MoH encrypted |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Must Support | false |
| 52. Patient.identifier:enc.system | |
| Fixed Value | http://fhir.health.gov.il/identifier/encrypted-id-primary-moh |
| 54. Patient.identifier:enc.value | |
| Short | An encrypted identifier |
| Example | <br/><b>Valid Example</b>:000000018 |
| 56. Patient.identifier:enc.assigner | |
| Type | Reference(ILCore Organization Profile) |
| 58. Patient.identifier:visa-num | |
| Slice Name | visa-num |
| Definition | Israeli Temporary Visa number |
| Short | Israeli Temporary Visa number |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Must Support | true |
| 60. Patient.identifier:visa-num.system | |
| Fixed Value | http://fhir.health.gov.il/identifier/il-visa-num |
| 62. Patient.identifier:visa-num.value | |
| Short | An Israeli Visa Number |
| Example | <br/><b>Valid Example</b>:000000018 |
| 64. Patient.identifier:visa-num.assigner | |
| Type | Reference(ILCore Organization Profile) |
| 66. Patient.name | |
| Control | 1..? |
| Must Support | true |
| Invariants | il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. ((family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()) |
| Slicing | This element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. Patient.name.extension:dataAbsentReason | |
| Slice Name | dataAbsentReason |
| Control | 0..1 |
| Type | Extension(Data Absent Reason) (Extension Type: code) |
| 70. Patient.name.family | |
| Must Support | true |
| 72. Patient.name.given | |
| Must Support | true |
| 74. Patient.name:Hebrew | |
| Slice Name | Hebrew |
| Control | 0..* |
| 76. Patient.name:Hebrew.extension | |
| Control | 1..? |
| 78. Patient.name:Hebrew.extension:dataAbsentReason | |
| Slice Name | dataAbsentReason |
| Control | 0..1 |
| Type | Extension(Data Absent Reason) (Extension Type: code) |
| 80. Patient.name:Hebrew.extension:language | |
| Slice Name | language |
| Control | 1..1 |
| Type | Extension(Human Language) (Extension Type: code) |
| 82. Patient.name:Hebrew.extension:language.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Fixed Value | he |
| 84. Patient.name:English | |
| Slice Name | English |
| Control | 0..* |
| 86. Patient.name:English.extension | |
| Control | 1..? |
| 88. Patient.name:English.extension:dataAbsentReason | |
| Slice Name | dataAbsentReason |
| Control | 0..1 |
| Type | Extension(Data Absent Reason) (Extension Type: code) |
| 90. Patient.name:English.extension:language | |
| Slice Name | language |
| Control | 1..1 |
| Type | Extension(Human Language) (Extension Type: code) |
| 92. Patient.name:English.extension:language.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Fixed Value | en |
| 94. Patient.name:Arabic | |
| Slice Name | Arabic |
| Control | 0..* |
| 96. Patient.name:Arabic.extension | |
| Control | 1..? |
| 98. Patient.name:Arabic.extension:dataAbsentReason | |
| Slice Name | dataAbsentReason |
| Control | 0..1 |
| Type | Extension(Data Absent Reason) (Extension Type: code) |
| 100. Patient.name:Arabic.extension:language | |
| Slice Name | language |
| Control | 1..1 |
| Type | Extension(Human Language) (Extension Type: code) |
| 102. Patient.name:Arabic.extension:language.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Fixed Value | ar |
| 104. Patient.telecom | |
| 106. Patient.telecom.system | |
| Control | 1..? |
| Must Support | true |
| 108. Patient.telecom.value | |
| Control | 1..? |
| Must Support | true |
| 110. Patient.telecom.use | |
| Must Support | true |
| 112. Patient.gender | |
| Control | 1..? |
| Must Support | true |
| 114. Patient.birthDate | |
| Control | 1..? |
| Must Support | true |
| LOINC Code | |
| 116. Patient.address | |
| Type | Address(ILCore Address Profile) |
| 118. Patient.contact | |
| Slicing | This element introduces a set of slices on Patient.contact. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 120. Patient.contact.organization | |
| Type | Reference(ILCore Organization Profile) |
| 122. Patient.contact:Parent | |
| Slice Name | Parent |
| Control | 0..* |
| 124. Patient.contact:Parent.relationship | |
| 126. Patient.contact:Parent.relationship.coding | |
| Pattern Value | { |
| 128. Patient.communication | |
| 130. Patient.communication.language | |
| Must Support | true |
| 132. Patient.generalPractitioner | |
| Type | Reference(ILCore Organization Profile, ILCore Practitioner Profile, ILCore PractitionerRole Profile) |
| 134. Patient.managingOrganization | |
| Type | Reference(ILCore Organization Profile) |
| 136. Patient.link | |
| 138. Patient.link.other | |
| Type | Reference(ILCore Patient Profile, ILCore RelatedPerson Profile) |
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |||||
| Definition | The Patient Profile is based upon the core FHIR Patient Resource Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||||
| Short | ILCore Patient profileInformation about an individual or animal receiving health care services | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | SubjectOfCare Client Resident | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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 (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) | ||||
| 2. Patient.implicitRules | |||||
| 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. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 4. Patient.extension | |||||
| Definition | An Extension 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 manageable, 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. | ||||
| Short | ExtensionAdditional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 6. Patient.extension:hmo | |||||
| Slice Name | hmo | ||||
| Definition | A code classifying the person's Israeli HMO | ||||
| Short | Extension: Israel Core HMO (קופת חולים) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Ext: Israel Health Management Organization (קופת חולים)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 8. Patient.extension:parentName | |||||
| Slice Name | parentName | ||||
| Definition | Extension: The name of a person’s parent, recorded for administrative purposes as part of the person’s demographics (e.g to help with identification). This SHOULD NOT be confused with a parent whose details are recorded for contact purposes (Patient.contact) or as a family member (RelatedPerson). Most systems will use the “father’s name” field as the source of data for this extension. NOTE: This extension replaces the old ParentName extension and is the PREFFERED extension | ||||
| Short | Extension: Administrative Parent Name | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Ext: Administrative Parent Name) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 10. Patient.extension:birthPlace | |||||
| Slice Name | birthPlace | ||||
| Definition | The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements | ||||
| Short | Extension: Place of Birth for patient | ||||
| Control | 0..1 | ||||
| Type | Extension(Patient Birth Place) (Extension Type: Address) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 12. Patient.extension:immigration | |||||
| Slice Name | immigration | ||||
| Definition | Extension: Immigration information for a patient - for the purpose of this extension - immigration is an international movement of a person to a destination country in order to settle as permanent resident | ||||
| Short | Extension: Patient Immigration | ||||
| Comments | In case of an Aliyah (A jew immigrating to Israel), the destination should be 'IL' (Israel) | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Ext: Patient Immigration) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 14. Patient.extension:birthSex | |||||
| Slice Name | birthSex | ||||
| Definition | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9). | ||||
| Short | Extension: US Core Birth Sex Extension | ||||
| Comments | The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(US Core Birth Sex Extension) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 16. Patient.modifierExtension | |||||
| 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| 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. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 18. Patient.identifier | |||||
| Definition | An identifier for this patient. | ||||
| Short | An identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 10..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 20. Patient.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. Patient.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 10..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. Patient.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique within the system. | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 10..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Patient.identifier:il-id | |||||
| Slice Name | il-id | ||||
| Definition | Israeli ID number (9 digit unchangeable number, including leading zeros and includes a control digit), including temporarily identification numbers assigned by Israeli National Insurance An identifier for this patient. | ||||
| Short | Israeli National IdentifierAn identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. Patient.identifier:il-id.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 30. Patient.identifier:il-id.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/il-national-id | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 32. Patient.identifier:il-id.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | An Israeli ID numberThe value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:000000018 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end. ( matches('[0-9]{9}$') and
substring(8,1).toInteger()=
(10-((substring(0,1).toInteger() +
substring(1,1).toInteger()*2 mod 10 +
substring(1,1).toInteger()*2 div 10 +
substring(2,1).toInteger() +
substring(3,1).toInteger()*2 mod 10 +
substring(3,1).toInteger()*2 div 10 +
substring(4,1).toInteger() +
substring(5,1).toInteger()*2 mod 10 +
substring(5,1).toInteger()*2 div 10 +
substring(6,1).toInteger() +
substring(7,1).toInteger()*2 mod 10 +
substring(7,1).toInteger()*2 div 10) mod 10)) mod 10) | ||||
| 34. Patient.identifier:il-id.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile, Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. Patient.identifier:pna-id | |||||
| Slice Name | pna-id | ||||
| Definition | Palestinian ID number An identifier for this patient. | ||||
| Short | Palestinian National IdentifierAn identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. Patient.identifier:pna-id.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. Patient.identifier:pna-id.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/pna-national-id | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. Patient.identifier:pna-id.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | A Palestininan ID numberThe value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:000000018 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. Patient.identifier:ppn | |||||
| Slice Name | ppn | ||||
| Definition | Passport number An identifier for this patient. | ||||
| Short | Passport NumberAn identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. Patient.identifier:ppn.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. Patient.identifier:ppn.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. Patient.identifier:ppn.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from For codes, see Passport URIs (required to http://fhir.health.gov.il/ValueSet/passport-uri) | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. Patient.identifier:ppn.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | Passport NumberThe value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. Patient.identifier:prisoner-id | |||||
| Slice Name | prisoner-id | ||||
| Definition | Israel Prison Service prisoner number (5-6 digits number). A unique identifier for any prisoner currently serving a prison sentence An identifier for this patient. | ||||
| Short | Prisoner NumberAn identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. Patient.identifier:prisoner-id.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. Patient.identifier:prisoner-id.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/il-prisoner-number | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. Patient.identifier:prisoner-id.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | Prisoner NumberThe value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters ( matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')) | ||||
| 62. Patient.identifier:prisoner-id.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile, Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. Patient.identifier:enc | |||||
| Slice Name | enc | ||||
| Definition | The person’s identifier after applying MoH’s standard primary encryption algorithm An identifier for this patient. | ||||
| Short | Person's Identifier - MoH encryptedAn identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. Patient.identifier:enc.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. Patient.identifier:enc.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/encrypted-id-primary-moh | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 70. Patient.identifier:enc.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | An encrypted identifierThe value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:000000018 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. Patient.identifier:enc.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile, Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. Patient.identifier:visa-num | |||||
| Slice Name | visa-num | ||||
| Definition | Israeli Temporary Visa number An identifier for this patient. | ||||
| Short | Israeli Temporary Visa numberAn identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. Patient.identifier:visa-num.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. Patient.identifier:visa-num.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/il-visa-num | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. Patient.identifier:visa-num.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | An Israeli Visa NumberThe value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:000000018 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. Patient.identifier:visa-num.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile, Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. Patient.active | |||||
| Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. | ||||
| Short | Whether this patient's record is in active use | ||||
| Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. Patient.name | |||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | A patient 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. | ||||
| Control | 10..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. ( (family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 88. Patient.name.extension:dataAbsentReason | |||||
| Slice Name | dataAbsentReason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | unknown | asked | temp | notasked | masked | unsupported | astext | error | ||||
| Control | 0..1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 90. Patient.name.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 92. Patient.name.family | |||||
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||
| Short | Family name (often called 'Surname') | ||||
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Alternate Names | surname | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 94. Patient.name.given | |||||
| Definition | Given name. | ||||
| Short | Given names (not always 'first'). Includes middle names | ||||
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Alternate Names | first name, middle name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. Patient.name:Hebrew | |||||
| Slice Name | Hebrew | ||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | A patient 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. | ||||
| Control | 0..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 98. Patient.name:Hebrew.extension | |||||
| Definition | An Extension 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 manageable, 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. | ||||
| Short | ExtensionAdditional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 10..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 100. Patient.name:Hebrew.extension:dataAbsentReason | |||||
| Slice Name | dataAbsentReason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | unknown | asked | temp | notasked | masked | unsupported | astext | error | ||||
| Control | 0..1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 102. Patient.name:Hebrew.extension:language | |||||
| Slice Name | language | ||||
| Definition | The Human Language of the item. | ||||
| Short | Human Language for the item | ||||
| Comments | This is used where an item may repeat to indicate the language of each repeat. | ||||
| Control | 1..1 | ||||
| Type | Extension(Human Language) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 104. Patient.name:Hebrew.extension:language.extension | |||||
| Definition | An Extension 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 manageable, 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. | ||||
| Short | ExtensionAdditional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..0* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 106. Patient.name:Hebrew.extension:language.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/language | ||||
| 108. Patient.name:Hebrew.extension:language.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||
| Binding | The codes SHOULD be taken from For codes, see CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)IETF language tag
| ||||
| Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Fixed Value | he | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 110. Patient.name:Hebrew.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 112. Patient.name:English | |||||
| Slice Name | English | ||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | A patient 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. | ||||
| Control | 0..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 114. Patient.name:English.extension | |||||
| Definition | An Extension 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 manageable, 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. | ||||
| Short | ExtensionAdditional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 10..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 116. Patient.name:English.extension:dataAbsentReason | |||||
| Slice Name | dataAbsentReason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | unknown | asked | temp | notasked | masked | unsupported | astext | error | ||||
| Control | 0..1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 118. Patient.name:English.extension:language | |||||
| Slice Name | language | ||||
| Definition | The Human Language of the item. | ||||
| Short | Human Language for the item | ||||
| Comments | This is used where an item may repeat to indicate the language of each repeat. | ||||
| Control | 1..1 | ||||
| Type | Extension(Human Language) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 120. Patient.name:English.extension:language.extension | |||||
| Definition | An Extension 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 manageable, 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. | ||||
| Short | ExtensionAdditional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..0* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 122. Patient.name:English.extension:language.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/language | ||||
| 124. Patient.name:English.extension:language.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||
| Binding | The codes SHOULD be taken from For codes, see CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)IETF language tag
| ||||
| Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Fixed Value | en | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 126. Patient.name:English.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 128. Patient.name:Arabic | |||||
| Slice Name | Arabic | ||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | A patient 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. | ||||
| Control | 0..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 130. Patient.name:Arabic.extension | |||||
| Definition | An Extension 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 manageable, 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. | ||||
| Short | ExtensionAdditional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 10..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 132. Patient.name:Arabic.extension:dataAbsentReason | |||||
| Slice Name | dataAbsentReason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | unknown | asked | temp | notasked | masked | unsupported | astext | error | ||||
| Control | 0..1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 134. Patient.name:Arabic.extension:language | |||||
| Slice Name | language | ||||
| Definition | The Human Language of the item. | ||||
| Short | Human Language for the item | ||||
| Comments | This is used where an item may repeat to indicate the language of each repeat. | ||||
| Control | 1..1 | ||||
| Type | Extension(Human Language) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 136. Patient.name:Arabic.extension:language.extension | |||||
| Definition | An Extension 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 manageable, 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. | ||||
| Short | ExtensionAdditional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..0* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 138. Patient.name:Arabic.extension:language.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/language | ||||
| 140. Patient.name:Arabic.extension:language.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||
| Binding | The codes SHOULD be taken from For codes, see CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)IETF language tag
| ||||
| Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Fixed Value | ar | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 142. Patient.name:Arabic.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 144. Patient.telecom | |||||
| Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | ||||
| Short | A contact detail for the individual | ||||
| Comments | A Patient 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. The address might 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). | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 146. Patient.telecom.system | |||||
| Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||
| Short | phone | fax | email | pager | url | sms | other | ||||
| Control | 10..1 This element is affected by the following invariants: cpt-2 | ||||
| Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)Telecommunications form for contact point. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 148. Patient.telecom.value | |||||
| Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | ||||
| Short | The actual contact point details | ||||
| Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||
| Control | 10..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 150. Patient.telecom.use | |||||
| Definition | Identifies the purpose for the contact point. | ||||
| Short | home | work | temp | old | mobile - purpose of this contact point | ||||
| Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)Use of contact point. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 152. Patient.gender | |||||
| Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. | ||||
| Short | male | female | other | unknown | ||||
| Comments | 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 male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. | ||||
| Control | 10..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)The gender of a person used for administrative purposes. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 154. Patient.birthDate | |||||
| Definition | The date of birth for the individual. | ||||
| Short | The date of birth for the individual | ||||
| Comments | At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). | ||||
| Control | 10..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Age of the individual drives many clinical processes. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| LOINC Code | 21112-8 | ||||
| 156. Patient.deceased[x] | |||||
| Definition | Indicates if the individual is deceased or not. | ||||
| Short | 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. | ||||
| Control | 0..1 | ||||
| Type | Choice of: boolean, dateTime | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 158. Patient.address | |||||
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. An address for the individual. | ||||
| Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats)An address for the individual | ||||
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Patient may have multiple addresses with different uses or applicable periods. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Address(ILCore Address Profile) | ||||
| Is Modifier | false | ||||
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 160. Patient.contact | |||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||
| Short | 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. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to track people you can contact about the patient. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pat-1: SHALL at least contain a contact's details or a reference to an organization ( name.exists() or telecom.exists() or address.exists() or organization.exists())pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.contact. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 162. Patient.contact.modifierExtension | |||||
| 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 164. Patient.contact.organization | |||||
| Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||
| Short | Organization that is associated with the contact | ||||
| Control | 0..1 This element is affected by the following invariants: pat-1 | ||||
| Type | Reference(ILCore Organization Profile, Organization) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | For guardians or business related contacts, the organization is relevant. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 166. Patient.contact:Parent | |||||
| Slice Name | Parent | ||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||
| Short | 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. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to track people you can contact about the patient. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pat-1: SHALL at least contain a contact's details or a reference to an organization ( name.exists() or telecom.exists() or address.exists() or organization.exists())pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists()) | ||||
| 168. Patient.contact:Parent.modifierExtension | |||||
| 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 170. Patient.communication | |||||
| Definition | A language which may be used to communicate with the patient about his or her health. | ||||
| Short | A language 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. If you need to convey proficiency for multiple modes, then you need multiple Patient.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. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 172. Patient.communication.modifierExtension | |||||
| 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 174. Patient.communication.language | |||||
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||||
| Short | The language which can be used to communicate with the patient about his or her health | ||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 176. Patient.generalPractitioner | |||||
| Definition | Patient's nominated care provider. | ||||
| Short | Patient's nominated primary care provider | ||||
| Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. | ||||
| Control | 0..* | ||||
| Type | Reference(ILCore Organization Profile, ILCore Practitioner Profile, ILCore PractitionerRole Profile, Organization, Practitioner, PractitionerRole) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | careProvider | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 178. Patient.managingOrganization | |||||
| Definition | Organization that is the custodian of the patient record. | ||||
| Short | Organization that is the custodian of the patient record | ||||
| Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile, Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to know who recognizes this patient record, manages and updates it. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 180. Patient.link | |||||
| Definition | Link to another patient resource that concerns the same actual patient. | ||||
| Short | Link to another patient resource that concerns the same actual person | ||||
| Comments | There is no assumption that linked patient records have mutual links. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by' | ||||
| Summary | true | ||||
| Requirements | There are multiple use cases:
| ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 182. Patient.link.modifierExtension | |||||
| 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 184. Patient.link.other | |||||
| Definition | The other patient resource that the link refers to. | ||||
| Short | The other patient or related person resource that the link refers to | ||||
| Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||||
| Control | 1..1 | ||||
| Type | Reference(ILCore Patient Profile, ILCore RelatedPerson Profile, Patient, RelatedPerson) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 186. Patient.link.type | |||||
| Definition | The type of link between this patient resource and another patient resource. | ||||
| Short | replaced-by | replaces | refer | seealso | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)The type of link between this patient resource and another patient resource. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |||||
| Definition | The Patient Profile is based upon the core FHIR Patient Resource | ||||
| Short | ILCore Patient profile | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | SubjectOfCare Client Resident | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: 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 ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | ||||
| 2. Patient.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. Patient.meta | |||||
| 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Patient.implicitRules | |||||
| 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. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. Patient.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. Patient.text | |||||
| 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. Patient.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. Patient.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. Patient.extension:hmo | |||||
| Slice Name | hmo | ||||
| Definition | A code classifying the person's Israeli HMO | ||||
| Short | Extension: Israel Core HMO (קופת חולים) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Ext: Israel Health Management Organization (קופת חולים)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. Patient.extension:parentName | |||||
| Slice Name | parentName | ||||
| Definition | Extension: The name of a person’s parent, recorded for administrative purposes as part of the person’s demographics (e.g to help with identification). This SHOULD NOT be confused with a parent whose details are recorded for contact purposes (Patient.contact) or as a family member (RelatedPerson). Most systems will use the “father’s name” field as the source of data for this extension. NOTE: This extension replaces the old ParentName extension and is the PREFFERED extension | ||||
| Short | Extension: Administrative Parent Name | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Ext: Administrative Parent Name) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. Patient.extension:birthPlace | |||||
| Slice Name | birthPlace | ||||
| Definition | The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements | ||||
| Short | Extension: Place of Birth for patient | ||||
| Control | 0..1 | ||||
| Type | Extension(Patient Birth Place) (Extension Type: Address) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. Patient.extension:immigration | |||||
| Slice Name | immigration | ||||
| Definition | Extension: Immigration information for a patient - for the purpose of this extension - immigration is an international movement of a person to a destination country in order to settle as permanent resident | ||||
| Short | Extension: Patient Immigration | ||||
| Comments | In case of an Aliyah (A jew immigrating to Israel), the destination should be 'IL' (Israel) | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Ext: Patient Immigration) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. Patient.extension:birthSex | |||||
| Slice Name | birthSex | ||||
| Definition | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9). | ||||
| Short | Extension: US Core Birth Sex Extension | ||||
| Comments | The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(US Core Birth Sex Extension) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. Patient.modifierExtension | |||||
| 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| 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. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 28. Patient.identifier | |||||
| Definition | An identifier for this patient. | ||||
| Short | An identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 1..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 30. Patient.identifier.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 32. Patient.identifier.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 34. Patient.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. Patient.identifier.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. Patient.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. Patient.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique within the system. | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. Patient.identifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. Patient.identifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. Patient.identifier:il-id | |||||
| Slice Name | il-id | ||||
| Definition | Israeli ID number (9 digit unchangeable number, including leading zeros and includes a control digit), including temporarily identification numbers assigned by Israeli National Insurance | ||||
| Short | Israeli National Identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. Patient.identifier:il-id.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 50. Patient.identifier:il-id.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 52. Patient.identifier:il-id.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. Patient.identifier:il-id.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. Patient.identifier:il-id.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/il-national-id | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. Patient.identifier:il-id.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | An Israeli ID number | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:000000018 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end. ( matches('[0-9]{9}$') and
substring(8,1).toInteger()=
(10-((substring(0,1).toInteger() +
substring(1,1).toInteger()*2 mod 10 +
substring(1,1).toInteger()*2 div 10 +
substring(2,1).toInteger() +
substring(3,1).toInteger()*2 mod 10 +
substring(3,1).toInteger()*2 div 10 +
substring(4,1).toInteger() +
substring(5,1).toInteger()*2 mod 10 +
substring(5,1).toInteger()*2 div 10 +
substring(6,1).toInteger() +
substring(7,1).toInteger()*2 mod 10 +
substring(7,1).toInteger()*2 div 10) mod 10)) mod 10) | ||||
| 60. Patient.identifier:il-id.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 62. Patient.identifier:il-id.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. Patient.identifier:pna-id | |||||
| Slice Name | pna-id | ||||
| Definition | Palestinian ID number | ||||
| Short | Palestinian National Identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. Patient.identifier:pna-id.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 68. Patient.identifier:pna-id.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 70. Patient.identifier:pna-id.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. Patient.identifier:pna-id.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. Patient.identifier:pna-id.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/pna-national-id | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. Patient.identifier:pna-id.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | A Palestininan ID number | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:000000018 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. Patient.identifier:pna-id.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. Patient.identifier:pna-id.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. Patient.identifier:ppn | |||||
| Slice Name | ppn | ||||
| Definition | Passport number | ||||
| Short | Passport Number | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. Patient.identifier:ppn.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 86. Patient.identifier:ppn.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 88. Patient.identifier:ppn.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. Patient.identifier:ppn.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 92. Patient.identifier:ppn.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from Passport URIs (required to http://fhir.health.gov.il/ValueSet/passport-uri) | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 94. Patient.identifier:ppn.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | Passport Number | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. Patient.identifier:ppn.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 98. Patient.identifier:ppn.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. Patient.identifier:prisoner-id | |||||
| Slice Name | prisoner-id | ||||
| Definition | Israel Prison Service prisoner number (5-6 digits number). A unique identifier for any prisoner currently serving a prison sentence | ||||
| Short | Prisoner Number | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 102. Patient.identifier:prisoner-id.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 104. Patient.identifier:prisoner-id.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 106. Patient.identifier:prisoner-id.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 108. Patient.identifier:prisoner-id.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 110. Patient.identifier:prisoner-id.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/il-prisoner-number | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 112. Patient.identifier:prisoner-id.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | Prisoner Number | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters ( matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')) | ||||
| 114. Patient.identifier:prisoner-id.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 116. Patient.identifier:prisoner-id.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 118. Patient.identifier:enc | |||||
| Slice Name | enc | ||||
| Definition | The person’s identifier after applying MoH’s standard primary encryption algorithm | ||||
| Short | Person's Identifier - MoH encrypted | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 120. Patient.identifier:enc.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 122. Patient.identifier:enc.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 124. Patient.identifier:enc.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 126. Patient.identifier:enc.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 128. Patient.identifier:enc.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/encrypted-id-primary-moh | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 130. Patient.identifier:enc.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | An encrypted identifier | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:000000018 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 132. Patient.identifier:enc.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 134. Patient.identifier:enc.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 136. Patient.identifier:visa-num | |||||
| Slice Name | visa-num | ||||
| Definition | Israeli Temporary Visa number | ||||
| Short | Israeli Temporary Visa number | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 138. Patient.identifier:visa-num.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 140. Patient.identifier:visa-num.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 142. Patient.identifier:visa-num.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 144. Patient.identifier:visa-num.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 146. Patient.identifier:visa-num.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Fixed Value | http://fhir.health.gov.il/identifier/il-visa-num | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 148. Patient.identifier:visa-num.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | An Israeli Visa Number | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 <br/><b>Valid Example</b>:000000018 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 150. Patient.identifier:visa-num.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 152. Patient.identifier:visa-num.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 154. Patient.active | |||||
| Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. | ||||
| Short | Whether this patient's record is in active use | ||||
| Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 156. Patient.name | |||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | A patient 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. | ||||
| Control | 1..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. ( (family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 158. Patient.name.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 160. Patient.name.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 162. Patient.name.extension:dataAbsentReason | |||||
| Slice Name | dataAbsentReason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | unknown | asked | temp | notasked | masked | unsupported | astext | error | ||||
| Control | 0..1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 164. Patient.name.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 166. Patient.name.text | |||||
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. | ||||
| Short | Text representation of the full name | ||||
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | A renderable, unencoded form. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 168. Patient.name.family | |||||
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||
| Short | Family name (often called 'Surname') | ||||
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Alternate Names | surname | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 170. Patient.name.given | |||||
| Definition | Given name. | ||||
| Short | Given names (not always 'first'). Includes middle names | ||||
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Alternate Names | first name, middle name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 172. Patient.name.prefix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||||
| Short | Parts that come before the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 174. Patient.name.suffix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||||
| Short | Parts that come after the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 176. Patient.name.period | |||||
| Definition | Indicates the period of time when this name was valid for the named person. | ||||
| Short | Time period when name was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows names to be placed in historical context. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 178. Patient.name:Hebrew | |||||
| Slice Name | Hebrew | ||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | A patient 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. | ||||
| Control | 0..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 180. Patient.name:Hebrew.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 182. Patient.name:Hebrew.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 184. Patient.name:Hebrew.extension:dataAbsentReason | |||||
| Slice Name | dataAbsentReason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | unknown | asked | temp | notasked | masked | unsupported | astext | error | ||||
| Control | 0..1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 186. Patient.name:Hebrew.extension:language | |||||
| Slice Name | language | ||||
| Definition | The Human Language of the item. | ||||
| Short | Human Language for the item | ||||
| Comments | This is used where an item may repeat to indicate the language of each repeat. | ||||
| Control | 1..1 | ||||
| Type | Extension(Human Language) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 188. Patient.name:Hebrew.extension:language.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 190. Patient.name:Hebrew.extension:language.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 192. Patient.name:Hebrew.extension:language.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/language | ||||
| 194. Patient.name:Hebrew.extension:language.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)IETF language tag
| ||||
| Type | code | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Fixed Value | he | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 196. Patient.name:Hebrew.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 198. Patient.name:Hebrew.text | |||||
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. | ||||
| Short | Text representation of the full name | ||||
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | A renderable, unencoded form. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 200. Patient.name:Hebrew.family | |||||
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||
| Short | Family name (often called 'Surname') | ||||
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | surname | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 202. Patient.name:Hebrew.given | |||||
| Definition | Given name. | ||||
| Short | Given names (not always 'first'). Includes middle names | ||||
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | first name, middle name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 204. Patient.name:Hebrew.prefix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||||
| Short | Parts that come before the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 206. Patient.name:Hebrew.suffix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||||
| Short | Parts that come after the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 208. Patient.name:Hebrew.period | |||||
| Definition | Indicates the period of time when this name was valid for the named person. | ||||
| Short | Time period when name was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows names to be placed in historical context. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 210. Patient.name:English | |||||
| Slice Name | English | ||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | A patient 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. | ||||
| Control | 0..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 212. Patient.name:English.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 214. Patient.name:English.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 216. Patient.name:English.extension:dataAbsentReason | |||||
| Slice Name | dataAbsentReason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | unknown | asked | temp | notasked | masked | unsupported | astext | error | ||||
| Control | 0..1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 218. Patient.name:English.extension:language | |||||
| Slice Name | language | ||||
| Definition | The Human Language of the item. | ||||
| Short | Human Language for the item | ||||
| Comments | This is used where an item may repeat to indicate the language of each repeat. | ||||
| Control | 1..1 | ||||
| Type | Extension(Human Language) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 220. Patient.name:English.extension:language.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 222. Patient.name:English.extension:language.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 224. Patient.name:English.extension:language.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/language | ||||
| 226. Patient.name:English.extension:language.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)IETF language tag
| ||||
| Type | code | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Fixed Value | en | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 228. Patient.name:English.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 230. Patient.name:English.text | |||||
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. | ||||
| Short | Text representation of the full name | ||||
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | A renderable, unencoded form. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 232. Patient.name:English.family | |||||
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||
| Short | Family name (often called 'Surname') | ||||
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | surname | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 234. Patient.name:English.given | |||||
| Definition | Given name. | ||||
| Short | Given names (not always 'first'). Includes middle names | ||||
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | first name, middle name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 236. Patient.name:English.prefix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||||
| Short | Parts that come before the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 238. Patient.name:English.suffix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||||
| Short | Parts that come after the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 240. Patient.name:English.period | |||||
| Definition | Indicates the period of time when this name was valid for the named person. | ||||
| Short | Time period when name was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows names to be placed in historical context. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 242. Patient.name:Arabic | |||||
| Slice Name | Arabic | ||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | A patient 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. | ||||
| Control | 0..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 244. Patient.name:Arabic.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 246. Patient.name:Arabic.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 248. Patient.name:Arabic.extension:dataAbsentReason | |||||
| Slice Name | dataAbsentReason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | unknown | asked | temp | notasked | masked | unsupported | astext | error | ||||
| Control | 0..1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 250. Patient.name:Arabic.extension:language | |||||
| Slice Name | language | ||||
| Definition | The Human Language of the item. | ||||
| Short | Human Language for the item | ||||
| Comments | This is used where an item may repeat to indicate the language of each repeat. | ||||
| Control | 1..1 | ||||
| Type | Extension(Human Language) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 252. Patient.name:Arabic.extension:language.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 254. Patient.name:Arabic.extension:language.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 256. Patient.name:Arabic.extension:language.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/language | ||||
| 258. Patient.name:Arabic.extension:language.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)IETF language tag
| ||||
| Type | code | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Fixed Value | ar | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 260. Patient.name:Arabic.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 262. Patient.name:Arabic.text | |||||
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. | ||||
| Short | Text representation of the full name | ||||
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | A renderable, unencoded form. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 264. Patient.name:Arabic.family | |||||
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||
| Short | Family name (often called 'Surname') | ||||
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | surname | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 266. Patient.name:Arabic.given | |||||
| Definition | Given name. | ||||
| Short | Given names (not always 'first'). Includes middle names | ||||
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | first name, middle name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 268. Patient.name:Arabic.prefix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||||
| Short | Parts that come before the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 270. Patient.name:Arabic.suffix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||||
| Short | Parts that come after the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 272. Patient.name:Arabic.period | |||||
| Definition | Indicates the period of time when this name was valid for the named person. | ||||
| Short | Time period when name was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows names to be placed in historical context. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 274. Patient.telecom | |||||
| Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | ||||
| Short | A contact detail for the individual | ||||
| Comments | A Patient 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. The address might 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). | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 276. Patient.telecom.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 278. Patient.telecom.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 280. Patient.telecom.system | |||||
| Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||
| Short | phone | fax | email | pager | url | sms | other | ||||
| Control | 1..1 This element is affected by the following invariants: cpt-2 | ||||
| Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)Telecommunications form for contact point. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 282. Patient.telecom.value | |||||
| Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | ||||
| Short | The actual contact point details | ||||
| Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 284. Patient.telecom.use | |||||
| Definition | Identifies the purpose for the contact point. | ||||
| Short | home | work | temp | old | mobile - purpose of this contact point | ||||
| Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ContactPointUse (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)Use of contact point. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 286. Patient.telecom.rank | |||||
| Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. | ||||
| Short | Specify preferred order of use (1 = highest) | ||||
| Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 288. Patient.telecom.period | |||||
| Definition | Time period when the contact point was/is in use. | ||||
| Short | Time period when the contact point was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 290. Patient.gender | |||||
| Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. | ||||
| Short | male | female | other | unknown | ||||
| Comments | 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 male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)The gender of a person used for administrative purposes. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 292. Patient.birthDate | |||||
| Definition | The date of birth for the individual. | ||||
| Short | The date of birth for the individual | ||||
| Comments | At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). | ||||
| Control | 1..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Age of the individual drives many clinical processes. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| LOINC Code | 21112-8 | ||||
| 294. Patient.deceased[x] | |||||
| Definition | Indicates if the individual is deceased or not. | ||||
| Short | 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. | ||||
| Control | 0..1 | ||||
| Type | Choice of: boolean, dateTime | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 296. Patient.address | |||||
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. | ||||
| Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Address(ILCore Address Profile) | ||||
| Is Modifier | false | ||||
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 298. Patient.maritalStatus | |||||
| Definition | This field contains a patient's most recent marital (civil) status. | ||||
| Short | Marital (civil) status of a patient | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Marital Status Codes (extensible to http://hl7.org/fhir/ValueSet/marital-status)The domestic partnership status of a person. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Most, if not all systems capture it. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 300. Patient.multipleBirth[x] | |||||
| Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||||
| Short | Whether patient is part of a multiple birth | ||||
| Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). | ||||
| Control | 0..1 | ||||
| Type | Choice of: boolean, integer | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 302. Patient.photo | |||||
| Definition | Image of the patient. | ||||
| Short | Image of the patient | ||||
| Comments | Guidelines:
| ||||
| Control | 0..* | ||||
| Type | Attachment | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 304. Patient.contact | |||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||
| Short | 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. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to track people you can contact about the patient. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))pat-1: SHALL at least contain a contact's details or a reference to an organization ( name.exists() or telecom.exists() or address.exists() or organization.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.contact. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 306. Patient.contact.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 308. Patient.contact.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 310. Patient.contact.modifierExtension | |||||
| 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 312. Patient.contact.relationship | |||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||
| Short | The kind of relationship | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationship (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)The nature of the relationship between a patient and a contact person for that patient. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 314. Patient.contact.name | |||||
| Definition | A name associated with the contact person. | ||||
| Short | A name associated with the contact person | ||||
| Control | 0..1 | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 316. Patient.contact.telecom | |||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||
| Short | A contact detail for the person | ||||
| Comments | Contact 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. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 318. Patient.contact.address | |||||
| Definition | Address for the contact person. | ||||
| Short | Address for the contact person | ||||
| Control | 0..1 | ||||
| Type | Address | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 320. Patient.contact.gender | |||||
| Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. | ||||
| Short | male | female | other | unknown | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)The gender of a person used for administrative purposes. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | Needed to address the person correctly. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 322. Patient.contact.organization | |||||
| Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||
| Short | Organization that is associated with the contact | ||||
| Control | 0..1 This element is affected by the following invariants: pat-1 | ||||
| Type | Reference(ILCore Organization Profile) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | For guardians or business related contacts, the organization is relevant. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 324. Patient.contact.period | |||||
| Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||||
| Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 326. Patient.contact:Parent | |||||
| Slice Name | Parent | ||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||
| Short | 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. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to track people you can contact about the patient. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))pat-1: SHALL at least contain a contact's details or a reference to an organization ( name.exists() or telecom.exists() or address.exists() or organization.exists()) | ||||
| 328. Patient.contact:Parent.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 330. Patient.contact:Parent.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 332. Patient.contact:Parent.modifierExtension | |||||
| 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 334. Patient.contact:Parent.relationship | |||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||
| Short | The kind of relationship | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationship (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)The nature of the relationship between a patient and a contact person for that patient. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 336. Patient.contact:Parent.relationship.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 338. Patient.contact:Parent.relationship.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.contact.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 340. Patient.contact:Parent.relationship.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..* | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 342. Patient.contact:Parent.relationship.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 344. Patient.contact:Parent.name | |||||
| Definition | A name associated with the contact person. | ||||
| Short | A name associated with the contact person | ||||
| Control | 0..1 | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 346. Patient.contact:Parent.telecom | |||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||
| Short | A contact detail for the person | ||||
| Comments | Contact 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. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 348. Patient.contact:Parent.address | |||||
| Definition | Address for the contact person. | ||||
| Short | Address for the contact person | ||||
| Control | 0..1 | ||||
| Type | Address | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 350. Patient.contact:Parent.gender | |||||
| Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. | ||||
| Short | male | female | other | unknown | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)The gender of a person used for administrative purposes. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | Needed to address the person correctly. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 352. Patient.contact:Parent.organization | |||||
| Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||
| Short | Organization that is associated with the contact | ||||
| Control | 0..1 This element is affected by the following invariants: pat-1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | For guardians or business related contacts, the organization is relevant. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 354. Patient.contact:Parent.period | |||||
| Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||||
| Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 356. Patient.communication | |||||
| Definition | A language which may be used to communicate with the patient about his or her health. | ||||
| Short | A language 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. If you need to convey proficiency for multiple modes, then you need multiple Patient.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. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 358. Patient.communication.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 360. Patient.communication.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 362. Patient.communication.modifierExtension | |||||
| 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 364. Patient.communication.language | |||||
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||||
| Short | The language which can be used to communicate with the patient about his or her health | ||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 366. Patient.communication.preferred | |||||
| Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). | ||||
| Short | Language preference indicator | ||||
| Comments | This language is specifically identified for communicating healthcare information. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 368. Patient.generalPractitioner | |||||
| Definition | Patient's nominated care provider. | ||||
| Short | Patient's nominated primary care provider | ||||
| Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. | ||||
| Control | 0..* | ||||
| Type | Reference(ILCore Organization Profile, ILCore Practitioner Profile, ILCore PractitionerRole Profile) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | careProvider | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 370. Patient.managingOrganization | |||||
| Definition | Organization that is the custodian of the patient record. | ||||
| Short | Organization that is the custodian of the patient record | ||||
| Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). | ||||
| Control | 0..1 | ||||
| Type | Reference(ILCore Organization Profile) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to know who recognizes this patient record, manages and updates it. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 372. Patient.link | |||||
| Definition | Link to another patient resource that concerns the same actual patient. | ||||
| Short | Link to another patient resource that concerns the same actual person | ||||
| Comments | There is no assumption that linked patient records have mutual links. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by' | ||||
| Summary | true | ||||
| Requirements | There are multiple use cases:
| ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 374. Patient.link.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 376. Patient.link.extension | |||||
| 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 manageable, 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 378. Patient.link.modifierExtension | |||||
| 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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 380. Patient.link.other | |||||
| Definition | The other patient resource that the link refers to. | ||||
| Short | The other patient or related person resource that the link refers to | ||||
| Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||||
| Control | 1..1 | ||||
| Type | Reference(ILCore Patient Profile, ILCore RelatedPerson Profile) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 382. Patient.link.type | |||||
| Definition | The type of link between this patient resource and another patient resource. | ||||
| Short | replaced-by | replaces | refer | seealso | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from LinkType (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)The type of link between this patient resource and another patient resource. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||