HL7® Austria FHIR® Core Implementation Guide
1.1.0 - STU2
HL7® Austria FHIR® Core Implementation Guide - Local Development build (v1.1.0). See the Directory of published versions
Definitions for the at-core-patient resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Patient | |||||
Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||||
Control | 0..* | ||||
Summary | false | ||||
Alternate Names | SubjectOfCare Client Resident | ||||
2. Patient.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
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. | ||||
3. 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. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
5. Patient.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Summary | false | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
6. 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. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
7. 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained 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. | ||||
8. Patient.extension | |||||
Definition | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
| ||||
9. Patient.extension:citizenship | |||||
SliceName | citizenship | ||||
Definition | The patient's legal status as citizen of a country. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(citizenship) (Complex Extension) | ||||
Invariants | Defined on this element 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:citizenship.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
11. Patient.extension:citizenship.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
12. Patient.extension:citizenship.extension:code | |||||
SliceName | code | ||||
Definition | An Extension | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined on this element 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()) | ||||
13. Patient.extension:citizenship.extension:code.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
14. Patient.extension:citizenship.extension:code.extension | |||||
Definition | An Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined on this element 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.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
15. Patient.extension:citizenship.extension:code.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Control | 1..1 | ||||
Type | uri | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
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. | ||||
Fixed Value | code | ||||
16. Patient.extension:citizenship.extension:code.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ELGA Country Code Value Set; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
17. Patient.extension:citizenship.extension:code.value[x].id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
18. Patient.extension:citizenship.extension:code.value[x].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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
19. Patient.extension:citizenship.extension:code.value[x].coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
20. Patient.extension:citizenship.extension:code.value[x].coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
21. Patient.extension:citizenship.extension:code.value[x].coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.extension.value[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
22. Patient.extension:citizenship.extension:code.value[x].coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Fixed Value | http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/CodeSystem/at-core-cs-iso-3166-1-alpha-3 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. Patient.extension:citizenship.extension:code.value[x].coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
24. Patient.extension:citizenship.extension:code.value[x].coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. Patient.extension:citizenship.extension:code.value[x].coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. Patient.extension:citizenship.extension:code.value[x].coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Patient.extension:citizenship.extension:code.value[x].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. | ||||
Control | 0..1 | ||||
Type | string | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Patient.extension:citizenship.extension:period | |||||
SliceName | period | ||||
Definition | Period when citizenship was effective. | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined on this element 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()) | ||||
29. Patient.extension:citizenship.extension:period.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
30. Patient.extension:citizenship.extension:period.extension | |||||
Definition | An Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined on this element 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.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
31. Patient.extension:citizenship.extension:period.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Control | 1..1 | ||||
Type | uri | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
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. | ||||
Fixed Value | period | ||||
32. Patient.extension:citizenship.extension:period.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Control | 1..1 | ||||
Type | Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
33. Patient.extension:citizenship.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Control | 1..1 | ||||
Type | uri | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
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. | ||||
Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-citizenship | ||||
34. Patient.extension:citizenship.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Control | 0..0 | ||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. Patient.extension:PatientReligion | |||||
SliceName | PatientReligion | ||||
Definition | HL7® Austria FHIR® Core Extension for the religion (registered in Austria) of a patient. The extension is used to encode the religious confession of a patient (only confessions registered in Austria). Furthermore, it uses the official [HL7 AT CodeSystem](https://termpub.gesundheit.gv.at:443/TermBrowser/gui/main/main.zul?loadType=CodeSystem&loadName=HL7 AT ReligionAustria) for religion and is therefore aligned with the ELGA ValueSet, respectively. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(PatientReligion) (Complex Extension) | ||||
Invariants | Defined on this element 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()) | ||||
36. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
37. Patient.identifier | |||||
Definition | An identifier for this patient. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
| ||||
38. Patient.identifier:socialSecurityNumber | |||||
SliceName | socialSecurityNumber | ||||
Definition | An identifier for this patient. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. Patient.identifier:socialSecurityNumber.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
40. Patient.identifier:socialSecurityNumber.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
| ||||
41. Patient.identifier:socialSecurityNumber.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. Patient.identifier:socialSecurityNumber.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. Patient.identifier:socialSecurityNumber.type.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
44. Patient.identifier:socialSecurityNumber.type.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
45. Patient.identifier:socialSecurityNumber.type.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. Patient.identifier:socialSecurityNumber.type.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
47. Patient.identifier:socialSecurityNumber.type.coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
48. Patient.identifier:socialSecurityNumber.type.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
49. Patient.identifier:socialSecurityNumber.type.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
50. Patient.identifier:socialSecurityNumber.type.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | SS | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. Patient.identifier:socialSecurityNumber.type.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Fixed Value | Social Security Number | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. Patient.identifier:socialSecurityNumber.type.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
53. Patient.identifier:socialSecurityNumber.type.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. Patient.identifier:socialSecurityNumber.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
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. | ||||
Comments | Identifier.system is always case sensitive. | ||||
Fixed Value | urn:oid:1.2.40.0.10.1.4.3.1 | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. Patient.identifier:socialSecurityNumber.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Example | General:123456 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
56. Patient.identifier:socialSecurityNumber.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
57. Patient.identifier:socialSecurityNumber.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
58. Patient.identifier:socialSecurityNumber.assigner.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
59. Patient.identifier:socialSecurityNumber.assigner.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.assigner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
60. Patient.identifier:socialSecurityNumber.assigner.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
61. Patient.identifier:socialSecurityNumber.assigner.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) | ||||
Type | uri | ||||
Summary | true | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
62. Patient.identifier:socialSecurityNumber.assigner.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. Patient.identifier:socialSecurityNumber.assigner.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Fixed Value | Dachverband der österreichischen Sozialversicherungsträger | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
64. Patient.identifier:bPK | |||||
SliceName | bPK | ||||
Definition | An identifier for this patient. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
65. Patient.identifier:bPK.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
66. Patient.identifier:bPK.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
| ||||
67. Patient.identifier:bPK.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
68. Patient.identifier:bPK.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
69. Patient.identifier:bPK.type.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
70. Patient.identifier:bPK.type.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
71. Patient.identifier:bPK.type.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
72. Patient.identifier:bPK.type.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
73. Patient.identifier:bPK.type.coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
74. Patient.identifier:bPK.type.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
75. Patient.identifier:bPK.type.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
76. Patient.identifier:bPK.type.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | NI | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
77. Patient.identifier:bPK.type.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Fixed Value | National unique individual identifier | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
78. Patient.identifier:bPK.type.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
79. Patient.identifier:bPK.type.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
80. Patient.identifier:bPK.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
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. | ||||
Comments | Identifier.system is always case sensitive. | ||||
Fixed Value | urn:oid:1.2.40.0.10.2.1.1.149 | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
81. Patient.identifier:bPK.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Example | General:123456 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
82. Patient.identifier:bPK.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
83. Patient.identifier:bPK.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
84. Patient.identifier:bPK.assigner.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
85. Patient.identifier:bPK.assigner.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.assigner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
86. Patient.identifier:bPK.assigner.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
87. Patient.identifier:bPK.assigner.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) | ||||
Type | uri | ||||
Summary | true | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
88. Patient.identifier:bPK.assigner.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
89. Patient.identifier:bPK.assigner.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Fixed Value | Bundesministerium für Inneres | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
90. Patient.identifier:localPatientId | |||||
SliceName | localPatientId | ||||
Definition | An identifier for this patient. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
91. Patient.identifier:localPatientId.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
92. Patient.identifier:localPatientId.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
| ||||
93. Patient.identifier:localPatientId.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
94. Patient.identifier:localPatientId.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
95. Patient.identifier:localPatientId.type.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
96. Patient.identifier:localPatientId.type.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
97. Patient.identifier:localPatientId.type.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
98. Patient.identifier:localPatientId.type.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
99. Patient.identifier:localPatientId.type.coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
100. Patient.identifier:localPatientId.type.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
101. Patient.identifier:localPatientId.type.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
102. Patient.identifier:localPatientId.type.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | PI | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
103. Patient.identifier:localPatientId.type.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Fixed Value | Patient internal identifier | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
104. Patient.identifier:localPatientId.type.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
105. Patient.identifier:localPatientId.type.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
106. Patient.identifier:localPatientId.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
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. | ||||
Comments | Identifier.system is always case sensitive. | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
107. Patient.identifier:localPatientId.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Example | General:123456 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
108. Patient.identifier:localPatientId.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
109. Patient.identifier:localPatientId.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
110. 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. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||||
Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. | ||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
111. Patient.name | |||||
Definition | A name associated with the individual. | ||||
Control | 1..* | ||||
Type | HumanName | ||||
Summary | true | ||||
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
112. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
113. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
| ||||
114. Patient.name.use | |||||
Definition | Identifies the purpose for this name. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from NameUse The use of a human name | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
115. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | A renderable, unencoded form. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
116. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | surname | ||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
117. Patient.name.given | |||||
Definition | Given name. | ||||
Control | 0..* | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | first name, middle name | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
118. 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. | ||||
Control | 0..* | ||||
Type | string | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
119. 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. | ||||
Control | 0..* | ||||
Type | string | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
120. Patient.name.period | |||||
Definition | Indicates the period of time when this name was valid for the named person. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Requirements | Allows names to be placed in historical context. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
121. Patient.telecom | |||||
Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | ||||
Control | 0..* | ||||
Type | ContactPoint | ||||
Summary | true | ||||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
122. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
123. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
| ||||
124. Patient.telecom.system | |||||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||
Control | 0..1 This element is affected by the following invariants: cpt-2 | ||||
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point | ||||
Type | code | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
125. 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). | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
126. Patient.telecom.use | |||||
Definition | Identifies the purpose for the contact point. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ContactPointUse Use of contact point | ||||
Type | code | ||||
Is Modifier | 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. | ||||
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
127. 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. | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Summary | true | ||||
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
128. Patient.telecom.period | |||||
Definition | Time period when the contact point was/is in use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
129. Patient.gender | |||||
Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
130. Patient.birthDate | |||||
Definition | The date of birth for the individual. | ||||
Control | 0..1 | ||||
Type | date | ||||
Summary | true | ||||
Requirements | Age of the individual drives many clinical processes. | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
LOINC Code | 21112-8 | ||||
131. Patient.deceased[x] | |||||
Definition | Indicates if the individual is deceased or not. | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, dateTime | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Is Modifier | true | ||||
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. | ||||
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. | ||||
Invariants | Defined on this element 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.deceased[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
132. Patient.deceased[x]:deceasedBoolean | |||||
SliceName | deceasedBoolean | ||||
Definition | Indicates if the individual is deceased or not. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Is Modifier | true | ||||
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. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
133. Patient.deceased[x]:deceasedDateTime | |||||
SliceName | deceasedDateTime | ||||
Definition | Indicates if the individual is deceased or not. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Is Modifier | true | ||||
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. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
134. 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. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Address(HL7ATCoreAddress) | ||||
Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||
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). | ||||
Invariants | Defined on this element at-addr-1: If the extension for street name is used then the value for line must not be empty (: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())) at-addr-2: If the extension for street number is used then the value for line must not be empty (: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())) at-addr-3: If the extension for floor/door number is used then the value for line must not be empty (: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
135. Patient.address.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
136. Patient.address.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
137. Patient.address.use | |||||
Definition | The purpose of this address. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AddressUse The use of an address | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows an appropriate address to be chosen from a list of many. | ||||
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. | ||||
Example | General:home | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
138. Patient.address.type | |||||
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AddressType The type of an address (physical / postal) | ||||
Type | code | ||||
Summary | true | ||||
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||||
Example | General:both | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
139. Patient.address.text | |||||
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | A renderable, unencoded form. | ||||
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
Example | General:137 Nowhere Street, Erewhon 9132 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
140. Patient.address.line | |||||
Definition | This component contains the street name, street number, floor and/or door number or additonal information (e.g. street direction, P.O. Box number, delivery hints, and similar address information). This information can be split into structured values in the line-components each defined by international ISO extensions. If these extensions are used then the information they contain has to be written in a concatenated way in the line element itself as well. This makes the usage easier for systems which don't use address data in a structured way. | ||||
Control | 0..* | ||||
Type | string | ||||
Summary | true | ||||
Example | General:137 Nowhere Street | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
141. Patient.address.line.id | |||||
Definition | unique id for the element within a resource (for internal references) | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
142. Patient.address.line.extension | |||||
Definition | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined on this element 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.address.line.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
143. Patient.address.line.extension:street | |||||
SliceName | street | ||||
Definition | Name of the street without the street number | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ADXP-streetName) (Extension Type: string) | ||||
Invariants | Defined on this element 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()) | ||||
144. Patient.address.line.extension:streetNumber | |||||
SliceName | streetNumber | ||||
Definition | Number of the street without the street name | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ADXP-houseNumber) (Extension Type: string) | ||||
Invariants | Defined on this element 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()) | ||||
145. Patient.address.line.extension:floorDoorNumber | |||||
SliceName | floorDoorNumber | ||||
Definition | Floor and/or door number | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ADXP-additionalLocator) (Extension Type: string) | ||||
Invariants | Defined on this element 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()) | ||||
146. Patient.address.line.extension:additionalInformation | |||||
SliceName | additionalInformation | ||||
Definition | Additional information about the street address | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AddressAdditionalInformation) (Extension Type: string) | ||||
Invariants | Defined on this element 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()) | ||||
147. Patient.address.line.value | |||||
Definition | The actual value | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Max Length | 1048576 | ||||
148. Patient.address.city | |||||
Definition | The name of the city, town, suburb, village or other community or delivery center. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | Municpality | ||||
Example | General:Erewhon | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
149. Patient.address.district | |||||
Definition | The name of the administrative area (county). | ||||
Control | 0..0 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | County | ||||
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||||
Example | General:Madison | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
150. Patient.address.state | |||||
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | Province, Territory | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
151. Patient.address.postalCode | |||||
Definition | A postal code designating a region defined by the postal service. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | Zip | ||||
Example | General:9132 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
152. Patient.address.country | |||||
Definition | Country - a nation as commonly understood or generally accepted. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
153. Patient.address.period | |||||
Definition | Time period when address was/is in use. | ||||
Control | 0..0 | ||||
Type | Period | ||||
Summary | true | ||||
Requirements | Allows addresses to be placed in historical context. | ||||
Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23"/> <end value="2010-07-01"/> </valuePeriod> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
154. Patient.maritalStatus | |||||
Definition | This field contains a patient's most recent marital (civil) status. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Marital Status Codes; other codes may be used where these codes are not suitable The domestic partnership status of a person | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | Most, if not all systems capture it. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
155. Patient.maritalStatus.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
156. Patient.maritalStatus.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.maritalStatus.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
157. Patient.maritalStatus.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
158. Patient.maritalStatus.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
159. Patient.maritalStatus.coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.maritalStatus.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
160. Patient.maritalStatus.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
161. Patient.maritalStatus.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
162. Patient.maritalStatus.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
163. Patient.maritalStatus.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
164. Patient.maritalStatus.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
165. Patient.maritalStatus.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
166. Patient.multipleBirth[x] | |||||
Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||||
Control | 0..1 | ||||
Type | Choice of: boolean, integer | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | false | ||||
Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||
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). | ||||
Invariants | Defined on this element 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.multipleBirth[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
167. Patient.multipleBirth[x]:multipleBirthBoolean | |||||
SliceName | multipleBirthBoolean | ||||
Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | false | ||||
Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
168. Patient.multipleBirth[x]:multipleBirthInteger | |||||
SliceName | multipleBirthInteger | ||||
Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||||
Control | 0..1 | ||||
Type | integer | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | false | ||||
Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
169. Patient.photo | |||||
Definition | Image of the patient. | ||||
Control | 0..* | ||||
Type | Attachment | ||||
Summary | false | ||||
Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. | ||||
Comments | Guidelines:
| ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
170. Patient.contact | |||||
Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Summary | false | ||||
Requirements | Need to track people you can contact about 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. | ||||
Invariants | Defined on this element 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()) | ||||
171. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
172. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
173. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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.contact.relationship | |||||
Definition | The nature of the relationship between the patient and the contact person. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from PatientContactRelationship; other codes may be used where these codes are not suitable The nature of the relationship between a patient and a contact person for that patient | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
175. Patient.contact.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
176. Patient.contact.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
| ||||
177. Patient.contact.relationship.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
178. Patient.contact.relationship.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
179. Patient.contact.relationship.coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
180. Patient.contact.relationship.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
181. Patient.contact.relationship.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
182. Patient.contact.relationship.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
183. Patient.contact.relationship.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
184. Patient.contact.relationship.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
185. Patient.contact.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
186. Patient.contact.name | |||||
Definition | A name associated with the contact person. | ||||
Control | 0..1 | ||||
Type | HumanName | ||||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
187. Patient.contact.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
188. Patient.contact.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
189. Patient.contact.name.use | |||||
Definition | Identifies the purpose for this name. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from NameUse The use of a human name | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
190. Patient.contact.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | A renderable, unencoded form. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
191. Patient.contact.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | surname | ||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
192. Patient.contact.name.given | |||||
Definition | Given name. | ||||
Control | 0..* | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | first name, middle name | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
193. Patient.contact.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. | ||||
Control | 0..* | ||||
Type | string | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
194. Patient.contact.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. | ||||
Control | 0..* | ||||
Type | string | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
195. Patient.contact.name.period | |||||
Definition | Indicates the period of time when this name was valid for the named person. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Requirements | Allows names to be placed in historical context. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
196. Patient.contact.telecom | |||||
Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||
Control | 0..* | ||||
Type | ContactPoint | ||||
Summary | false | ||||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
197. Patient.contact.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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
198. Patient.contact.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
199. Patient.contact.telecom.system | |||||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||
Control | 0..1 This element is affected by the following invariants: cpt-2 | ||||
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point | ||||
Type | code | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
200. Patient.contact.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). | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
201. Patient.contact.telecom.use | |||||
Definition | Identifies the purpose for the contact point. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ContactPointUse Use of contact point | ||||
Type | code | ||||
Is Modifier | 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. | ||||
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
202. Patient.contact.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. | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Summary | true | ||||
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
203. Patient.contact.telecom.period | |||||
Definition | Time period when the contact point was/is in use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
204. Patient.contact.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. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Address(HL7ATCoreAddress) | ||||
Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||
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). | ||||
Invariants | Defined on this element at-addr-1: If the extension for street name is used then the value for line must not be empty (: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())) at-addr-2: If the extension for street number is used then the value for line must not be empty (: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())) at-addr-3: If the extension for floor/door number is used then the value for line must not be empty (: line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
205. Patient.contact.address.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
206. Patient.contact.address.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
207. Patient.contact.address.use | |||||
Definition | The purpose of this address. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AddressUse The use of an address | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows an appropriate address to be chosen from a list of many. | ||||
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. | ||||
Example | General:home | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
208. Patient.contact.address.type | |||||
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AddressType The type of an address (physical / postal) | ||||
Type | code | ||||
Summary | true | ||||
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||||
Example | General:both | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
209. Patient.contact.address.text | |||||
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | A renderable, unencoded form. | ||||
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
Example | General:137 Nowhere Street, Erewhon 9132 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
210. Patient.contact.address.line | |||||
Definition | This component contains the street name, street number, floor and/or door number or additonal information (e.g. street direction, P.O. Box number, delivery hints, and similar address information). This information can be split into structured values in the line-components each defined by international ISO extensions. If these extensions are used then the information they contain has to be written in a concatenated way in the line element itself as well. This makes the usage easier for systems which don't use address data in a structured way. | ||||
Control | 0..* | ||||
Type | string | ||||
Summary | true | ||||
Example | General:137 Nowhere Street | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
211. Patient.contact.address.line.id | |||||
Definition | unique id for the element within a resource (for internal references) | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
212. Patient.contact.address.line.extension | |||||
Definition | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Invariants | Defined on this element 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.address.line.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
213. Patient.contact.address.line.extension:street | |||||
SliceName | street | ||||
Definition | Name of the street without the street number | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ADXP-streetName) (Extension Type: string) | ||||
Invariants | Defined on this element 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()) | ||||
214. Patient.contact.address.line.extension:streetNumber | |||||
SliceName | streetNumber | ||||
Definition | Number of the street without the street name | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ADXP-houseNumber) (Extension Type: string) | ||||
Invariants | Defined on this element 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()) | ||||
215. Patient.contact.address.line.extension:floorDoorNumber | |||||
SliceName | floorDoorNumber | ||||
Definition | Floor and/or door number | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ADXP-additionalLocator) (Extension Type: string) | ||||
Invariants | Defined on this element 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()) | ||||
216. Patient.contact.address.line.extension:additionalInformation | |||||
SliceName | additionalInformation | ||||
Definition | Additional information about the street address | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AddressAdditionalInformation) (Extension Type: string) | ||||
Invariants | Defined on this element 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()) | ||||
217. Patient.contact.address.line.value | |||||
Definition | The actual value | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Max Length | 1048576 | ||||
218. Patient.contact.address.city | |||||
Definition | The name of the city, town, suburb, village or other community or delivery center. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | Municpality | ||||
Example | General:Erewhon | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
219. Patient.contact.address.district | |||||
Definition | The name of the administrative area (county). | ||||
Control | 0..0 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | County | ||||
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||||
Example | General:Madison | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
220. Patient.contact.address.state | |||||
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | Province, Territory | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
221. Patient.contact.address.postalCode | |||||
Definition | A postal code designating a region defined by the postal service. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Alternate Names | Zip | ||||
Example | General:9132 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
222. Patient.contact.address.country | |||||
Definition | Country - a nation as commonly understood or generally accepted. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
223. Patient.contact.address.period | |||||
Definition | Time period when address was/is in use. | ||||
Control | 0..0 | ||||
Type | Period | ||||
Summary | true | ||||
Requirements | Allows addresses to be placed in historical context. | ||||
Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23"/> <end value="2010-07-01"/> </valuePeriod> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
224. Patient.contact.gender | |||||
Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes | ||||
Type | code | ||||
Summary | false | ||||
Requirements | Needed to address the person correctly. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
225. Patient.contact.organization | |||||
Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||
Control | 0..1 This element is affected by the following invariants: pat-1 | ||||
Type | Reference(Organization) | ||||
Summary | false | ||||
Requirements | For guardians or business related contacts, the organization is relevant. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
226. Patient.contact.period | |||||
Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
227. Patient.communication | |||||
Definition | A language which may be used to communicate with the patient about his or her health. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
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. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
228. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
229. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
230. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
231. 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. | ||||
Control | 1..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
232. Patient.communication.preferred | |||||
Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
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. | ||||
Comments | This language is specifically identified for communicating healthcare information. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
233. Patient.generalPractitioner | |||||
Definition | Patient's nominated care provider. | ||||
Control | 0..* | ||||
Type | Reference(Organization|Practitioner|PractitionerRole) | ||||
Summary | false | ||||
Alternate Names | careProvider | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
234. Patient.managingOrganization | |||||
Definition | Organization that is the custodian of the patient record. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
Requirements | Need to know who recognizes this patient record, manages and updates it. | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
235. Patient.link | |||||
Definition | Link to another patient resource that concerns the same actual patient. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | There are multiple use cases:
| ||||
Comments | There is no assumption that linked patient records have mutual links. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
236. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
237. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
238. 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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 | ||||
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. | ||||
Invariants | Defined on this element 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()) | ||||
239. Patient.link.other | |||||
Definition | The other patient resource that the link refers to. | ||||
Control | 1..1 | ||||
Type | Reference(Patient|RelatedPerson) | ||||
Summary | true | ||||
Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
240. Patient.link.type | |||||
Definition | The type of link between this patient resource and another patient resource. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from LinkType The type of link between this patient resource and another patient resource | ||||
Type | code | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |