Guia de Implementação do AnHealth
0.2.0 - CI Build
Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
| Draft as of 2021-11-10 |
Definitions for the Patient resource profile.
| 1. Patient | |
| 2. Patient.extension | |
| Control | 10..* |
| 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:
|
| 3. Patient.extension:birthCity | |
| SliceName | birthCity |
| Control | 0..1 |
| Type | Extension(City) (Extension Type: string) |
| 4. Patient.extension:nacionality | |
| SliceName | nacionality |
| Control | 0..1 |
| Type | Extension(Country) (Extension Type: CodeableConcept) |
| 5. Patient.extension:protectedPerson | |
| SliceName | protectedPerson |
| Control | 1..1 |
| Type | Extension(ProtectedPerson) (Extension Type: boolean) |
| 6. Patient.extension:race | |
| SliceName | race |
| Control | 0..1 |
| Type | Extension(Race) (Extension Type: CodeableConcept) |
| 7. Patient.extension:occupation | |
| SliceName | occupation |
| Control | 0..1 |
| Type | Extension(Occupation) (Extension Type: CodeableConcept) |
| 8. Patient.extension:motherName | |
| SliceName | motherName |
| Control | 0..1 |
| Type | Extension(MotherName) (Extension Type: string) |
| 9. Patient.extension:ethnicity | |
| SliceName | ethnicity |
| Control | 0..1 |
| Type | Extension(Ethnicity) (Extension Type: CodeableConcept) |
| 10. Patient.extension:educationLevel | |
| SliceName | educationLevel |
| Control | 0..1 |
| Type | Extension(EducationLevel) (Extension Type: CodeableConcept) |
| 11. Patient.extension:birthSex | |
| SliceName | birthSex |
| Control | 0..1 |
| Type | Extension(BirthSex) (Extension Type: CodeableConcept) |
| 12. Patient.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Type | Identifier(Identifier) |
| Invariants | Defined on this element ide-1: The Resource must have at least one Oficial Identifier (: null) |
| 13. Patient.identifier.type | |
| Control | 0..? |
| Binding | The codes SHALL be taken from IdentifierTypePerson |
| 14. Patient.active | |
| Control | 10..1 |
| 15. Patient.name | |
| Control | 10..* |
| Type | HumanName(HumanName) |
| 16. Patient.telecom | |
| Type | ContactPoint(ContactPoint) |
| 17. Patient.gender | |
| Control | 10..1 |
| 18. Patient.deceased[x] | |
| Type | Choice of: , boolean |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 19. Patient.address | |
| Type | Address(Address) |
| 20. Patient.maritalStatus | |
| Binding | The codes SHALL be taken from BrazilianMaritalStatusThe codes SHALL be taken from Marital Status Codes; other codes may be used where these codes are not suitable |
| 21. Patient.multipleBirth[x] | |
| Type | Choice of: , integer |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 22. Patient.photo | |
| Control | 0..1* |
| 23. Patient.photo.contentType | |
| Control | 0..? |
| Binding | The codes SHALL be taken from MimeType |
| 1. Patient | |
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Control | 0..* |
| Alternate Names | SubjectOfCare Client Resident |
| Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
| 2. Patient.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | 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())) |
| 3. Patient.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 10..* |
| Type | Extension |
| 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. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Patient.extension:birthCity | |
| SliceName | birthCity |
| Definition | An Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(City) (Extension Type: string) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 5. Patient.extension:nacionality | |
| SliceName | nacionality |
| Definition | An Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Country) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 6. Patient.extension:protectedPerson | |
| SliceName | protectedPerson |
| Definition | Optional Extension Element - found in all resources. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ProtectedPerson) (Extension Type: boolean) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 7. Patient.extension:race | |
| SliceName | race |
| Definition | Optional Extension Element - found in all resources. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Race) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 8. Patient.extension:occupation | |
| SliceName | occupation |
| Definition | An Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Occupation) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 9. Patient.extension:motherName | |
| SliceName | motherName |
| Definition | An Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(MotherName) (Extension Type: string) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 10. Patient.extension:ethnicity | |
| SliceName | ethnicity |
| Definition | An Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Ethnicity) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 11. Patient.extension:educationLevel | |
| SliceName | educationLevel |
| Definition | An Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(EducationLevel) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 12. Patient.extension:birthSex | |
| SliceName | birthSex |
| Definition | An Extension |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(BirthSex) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 13. 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 |
| 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()) |
| 14. Patient.identifier | |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. An identifier for this patient. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Identifier(Identifier) |
| 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 unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ide-1: The Resource must have at least one Oficial Identifier (: null) |
| 15. Patient.identifier.use | |
| Definition | The purpose of this identifier. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierUse |
| Type | code |
| Is Modifier | 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())) |
| 16. Patient.identifier.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 IdentifierTypePersonThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable |
| Type | CodeableConcept |
| 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())) |
| 17. Patient.identifier.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Control | 10..1* |
| Type | Coding |
| 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())) |
| 18. Patient.identifier.system | |
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
| Control | 10..1 |
| Type | uri |
| 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())) |
| 19. Patient.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Control | 10..1 |
| Type | string |
| 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())) |
| 20. 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 | 10..1 |
| Type | boolean |
| Is Modifier | 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())) |
| 21. Patient.name | |
| Definition | A human's name with the ability to identify parts and usage. A name associated with the individual. |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Type | HumanName(HumanName) |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. 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 unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 22. Patient.telecom | |
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | ContactPoint(ContactPoint) |
| Requirements | People have (primary) ways to contact them in some way such as phone, email. |
| Alternate Names | Contato, Informação de Contato, Telefone, E-Mail, Correio Eletrônico, Celular, Recado |
| 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 cpt-2: A system is required if a value is provided. (: value.empty() or system.exists()) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 23. Patient.gender | |
| Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes. |
| Type | code |
| 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())) |
| 24. Patient.deceased[x] | |
| Definition | Indicates if the individual is deceased or not. |
| Control | 0..1 |
| Type | Choice of: dateTime, boolean |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | 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())) |
| 25. Patient.address | |
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. An address for the individual. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Address(Address) |
| 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). Patient may have multiple addresses with different uses or applicable periods. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 26. Patient.maritalStatus | |
| Definition | This field contains a patient's most recent marital (civil) status. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from BrazilianMaritalStatusThe codes SHALL be taken from Marital Status Codes; other codes may be used where these codes are not suitable |
| Type | CodeableConcept |
| 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())) |
| 27. 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] |
| 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())) |
| 28. Patient.photo | |
| Definition | Image of the patient. |
| Control | 0..1* |
| Type | Attachment |
| 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())) |
| 29. Patient.photo.contentType | |
| Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MimeTypeThe codes SHALL be taken from Mime Types |
| Type | code |
| Requirements | Processors of the data need to be able to know how to interpret the data. |
| Example | General:text/plain; charset=UTF-8, image/png |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 30. Patient.link | |
| Definition | Link to another patient resource that concerns the same actual patient. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | 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 unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 31. 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 |
| 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()) |
| 32. Patient.link.other | |
| Definition | The other patient resource that the link refers to. |
| Control | 1..1 |
| Type | Reference(Patient|RelatedPerson)) |
| 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())) |
| 33. 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 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 1. Patient | |||||
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||||
| Control | 0..* | ||||
| 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 | ||||
| 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 | ||||
| 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 | ||||
| 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
IETF language ta
| ||||
| Type | code | ||||
| 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 | ||||
| Alternate Names | narrativehtmlxhtmldisplay | ||||
| 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 | ||||
| Alternate Names | inline resourcesanonymous resourcescontained 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. | ||||
| Invariants | Defined on this element dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)) | ||||
| 8. Patient.extension | |||||
| Definition | An Extension | ||||
| Control | 1..* | ||||
| Type | 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()) | ||||
| 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:birthCity | |||||
| SliceName | birthCity | ||||
| Definition | An Extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(City) (Extension Type: string) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 10. Patient.extension:nacionality | |||||
| SliceName | nacionality | ||||
| Definition | An Extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Country) (Extension Type: CodeableConcept) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 11. Patient.extension:protectedPerson | |||||
| SliceName | protectedPerson | ||||
| Definition | Optional Extension Element - found in all resources. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ProtectedPerson) (Extension Type: boolean) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 12. Patient.extension:race | |||||
| SliceName | race | ||||
| Definition | Optional Extension Element - found in all resources. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Race) (Extension Type: CodeableConcept) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 13. Patient.extension:occupation | |||||
| SliceName | occupation | ||||
| Definition | An Extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Occupation) (Extension Type: CodeableConcept) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 14. Patient.extension:motherName | |||||
| SliceName | motherName | ||||
| Definition | An Extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(MotherName) (Extension Type: string) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 15. Patient.extension:ethnicity | |||||
| SliceName | ethnicity | ||||
| Definition | An Extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Ethnicity) (Extension Type: CodeableConcept) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 16. Patient.extension:educationLevel | |||||
| SliceName | educationLevel | ||||
| Definition | An Extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(EducationLevel) (Extension Type: CodeableConcept) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 17. Patient.extension:birthSex | |||||
| SliceName | birthSex | ||||
| Definition | An Extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(BirthSex) (Extension Type: CodeableConcept) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
| 18. 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 | ||||
| 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 | extensionsuser 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()) | ||||
| 19. Patient.identifier | |||||
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier(Identifier) | ||||
| 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 unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ide-1: The Resource must have at least one Oficial Identifier (: ) | ||||
| 20. Patient.identifier.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| XML Representation | In the XML format, this property is represented as an attribute. | ||||
| 21. Patient.identifier.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensionsuser 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:
| ||||
| 22. Patient.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse | ||||
| Type | code | ||||
| Is Modifier | 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())) | ||||
| 23. Patient.identifier.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 IdentifierTypePerson | ||||
| Type | CodeableConcept | ||||
| 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())) | ||||
| 24. Patient.identifier.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 | id | ||||
| XML Representation | In the XML format, this property is represented as an attribute. | ||||
| 25. Patient.identifier.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 | ||||
| Alternate Names | extensionsuser 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:
| ||||
| 26. Patient.identifier.type.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Control | 1..1 | ||||
| Type | Coding | ||||
| 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())) | ||||
| 27. Patient.identifier.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 | ||||
| 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.identifier.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 | ||||
| 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())) | ||||
| 29. Patient.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| 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())) | ||||
| 30. Patient.identifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 31. Patient.identifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization)) | ||||
| 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())) | ||||
| 32. Patient.identifier.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 | id | ||||
| XML Representation | In the XML format, this property is represented as an attribute. | ||||
| 33. Patient.identifier.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 | ||||
| Alternate Names | extensionsuser 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:
| ||||
| 34. Patient.identifier.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 | 1..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 35. Patient.identifier.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 | 1..1 | ||||
| Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable | ||||
| Type | uri | ||||
| 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())) | ||||
| 36. Patient.identifier.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 | ||||
| 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())) | ||||
| 37. Patient.identifier.assigner.identifier.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| XML Representation | In the XML format, this property is represented as an attribute. | ||||
| 38. Patient.identifier.assigner.identifier.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensionsuser 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.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
| 39. Patient.identifier.assigner.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse | ||||
| Type | code | ||||
| Is Modifier | 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())) | ||||
| 40. Patient.identifier.assigner.identifier.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 | ||||
| Type | CodeableConcept | ||||
| 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())) | ||||
| 41. Patient.identifier.assigner.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| 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())) | ||||
| 42. Patient.identifier.assigner.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| 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())) | ||||
| 43. Patient.identifier.assigner.identifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 44. Patient.identifier.assigner.identifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization)) | ||||
| 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())) | ||||
| 45. Patient.identifier.assigner.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 46. 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 | 1..1 | ||||
| Type | boolean | ||||
| Is Modifier | 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())) | ||||
| 47. Patient.name | |||||
| Definition | A human's name with the ability to identify parts and usage. | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | HumanName(HumanName) | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 48. Patient.telecom | |||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | ContactPoint(ContactPoint) | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Alternate Names | ContatoInformação de ContatoTelefoneE-MailCorreio EletrônicoCelularRecado | ||||
| 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 cpt-2: A system is required if a value is provided. (: value.empty() or system.exists()) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 49. 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 | ||||
| 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())) | ||||
| 50. Patient.birthDate | |||||
| Definition | The date of birth for the individual. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| 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 | ||||
| 51. Patient.deceased[x] | |||||
| 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 | ||||
| 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())) | ||||
| 52. 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(Address) | ||||
| 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 ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 53. Patient.maritalStatus | |||||
| Definition | This field contains a patient's most recent marital (civil) status. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from BrazilianMaritalStatus | ||||
| Type | CodeableConcept | ||||
| 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())) | ||||
| 54. 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 | boolean | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| 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())) | ||||
| 55. Patient.photo | |||||
| Definition | Image of the patient. | ||||
| Control | 0..1 | ||||
| Type | Attachment | ||||
| 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())) | ||||
| 56. Patient.photo.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 | id | ||||
| XML Representation | In the XML format, this property is represented as an attribute. | ||||
| 57. Patient.photo.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 | ||||
| Alternate Names | extensionsuser 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.photo.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
| 58. Patient.photo.contentType | |||||
| Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from MimeType | ||||
| Type | code | ||||
| Requirements | Processors of the data need to be able to know how to interpret the data. | ||||
| Example | General:text/plain; charset=UTF-8, image/png | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 59. Patient.photo.language | |||||
| Definition | The human language of the content. The value can be any valid value according to BCP 47. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages
IETF language ta
| ||||
| Type | code | ||||
| Requirements | Users need to be able to choose between the languages in a set of attachments. | ||||
| Example | General:en-AU | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 60. Patient.photo.data | |||||
| Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. | ||||
| Control | 0..1 | ||||
| Type | base64Binary | ||||
| Requirements | The data needs to able to be transmitted inline. | ||||
| Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 61. Patient.photo.url | |||||
| Definition | A location where the data can be accessed. | ||||
| Control | 0..1 | ||||
| Type | url | ||||
| Requirements | The data needs to be transmitted by reference. | ||||
| Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. | ||||
| Example | General:http://www.acme.com/logo-small.png | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 62. Patient.photo.size | |||||
| Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). | ||||
| Control | 0..1 | ||||
| Type | unsignedInt | ||||
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. | ||||
| Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 63. Patient.photo.hash | |||||
| Definition | The calculated hash of the data using SHA-1. Represented using base64. | ||||
| Control | 0..1 | ||||
| Type | base64Binary | ||||
| Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). | ||||
| Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 64. Patient.photo.title | |||||
| Definition | A label or set of text to display in place of the data. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. | ||||
| Example | General:Official Corporate Logo | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 65. Patient.photo.creation | |||||
| Definition | The date that the attachment was first created. | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Requirements | This is often tracked as an integrity issue for use of the attachment. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 66. Patient.contact | |||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| 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 unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) 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()) | ||||
| 67. 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. | ||||
| 68. 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 | ||||
| Alternate Names | extensionsuser 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()) | ||||
| 69. 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 | ||||
| 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 | extensionsuser contentmodifiers | ||||
| 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()) | ||||
| 70. 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 | ||||
| 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())) | ||||
| 71. Patient.contact.name | |||||
| Definition | A name associated with the contact person. | ||||
| Control | 0..1 | ||||
| Type | HumanName | ||||
| 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())) | ||||
| 72. Patient.contact.telecom | |||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| 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())) | ||||
| 73. Patient.contact.address | |||||
| Definition | Address for the contact person. | ||||
| Control | 0..1 | ||||
| Type | Address | ||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 74. 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 | ||||
| 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())) | ||||
| 75. 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)) | ||||
| 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())) | ||||
| 76. 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 | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 77. Patient.communication | |||||
| Definition | A language which may be used to communicate with the patient about his or her health. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| 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 unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 78. 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. | ||||
| 79. 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 | ||||
| Alternate Names | extensionsuser 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()) | ||||
| 80. 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 | ||||
| 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 | extensionsuser contentmodifiers | ||||
| 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()) | ||||
| 81. 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
IETF language ta
| ||||
| Type | CodeableConcept | ||||
| 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())) | ||||
| 82. 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 | ||||
| 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())) | ||||
| 83. Patient.generalPractitioner | |||||
| Definition | Patient's nominated care provider. | ||||
| Control | 0..* | ||||
| Type | Reference(OrganizationPractitionerPractitionerRole)) | ||||
| 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())) | ||||
| 84. Patient.managingOrganization | |||||
| Definition | Organization that is the custodian of the patient record. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization)) | ||||
| 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())) | ||||
| 85. Patient.link | |||||
| Definition | Link to another patient resource that concerns the same actual patient. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | 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 unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 86. 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. | ||||
| 87. 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 | ||||
| Alternate Names | extensionsuser 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()) | ||||
| 88. 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 | ||||
| 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 | extensionsuser contentmodifiers | ||||
| 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()) | ||||
| 89. Patient.link.other | |||||
| Definition | The other patient resource that the link refers to. | ||||
| Control | 1..1 | ||||
| Type | Reference(PatientRelatedPerson)) | ||||
| 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())) | ||||
| 90. 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 | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||