Profile: Patient
PS-AB Simplifier Project Page: package/StructureDefinition-PatientPSAB.json
Derived from PS-CA Patient
Views of Profile Content
| Patient | I | Patient | Element idPatient Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services. Patient resources included in Alberta Patient Summary Document Bundles have rules that certain attributes are not to be contained in Patient resource. These are mechanically enforced through invariants at the PS-AB Bundle level.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Metadata about the resource DefinitionThe 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.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
| extension | I | 1..* | Extension | There are no (further) constraints on this element Element idPatient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| individual-recordedSexOrGender | S I | 1..* | Extension(Complex) | Element idPatient.extension:individual-recordedSexOrGender Extension for representing an individuals recorded sex or gender. Alternate namesextensions, user content DefinitionRecorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| value | I | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value The recorded sex or gender property for the individual Alternate namesextensions, user content DefinitionA sex or gender property for the individual from a document or other record 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. value
| |
| value[x] | 1..1 | Binding | Element idPatient.extension:individual-recordedSexOrGender.extension:value.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). package/ValueSet-administrative-gender-ab.json (required) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| type | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type Type of recorded sex or gender. Alternate namesextensions, user content DefinitionThe type or category of sex or gender that is recorded. Because the recorded sex or gender concept exists primarily as means to exchange sex and gender data concepts that are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, the type is used to identify what type of concept the recorded sex or gender concept is.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. type
| |
| value[x] | 1..1 | Binding | Element idPatient.extension:individual-recordedSexOrGender.extension:type.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). package/ValueSet-recorded-sex-or-gender-type-AB.json (required) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| effectivePeriod | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod When the recorded sex or gender value applies Alternate namesextensions, user content DefinitionThe time period during which the recorded sex or gender value applies to the individual 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. effectivePeriod
| |
| value[x] | 0..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||
| acquisitionDate | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate When the sex or gender value was recorded. Alternate namesextensions, user content DefinitionThe date/time when the sex or gender value was first recorded in the system. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. acquisitionDate
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
| sourceDocument | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument The document the sex or gender property was acquired from. Alternate namesextensions, user content DefinitionThe reference to the source document or the code representing the type of document where this sex or gender property is initially recorded. For example, if a driver's license is scanned, this property may reference that scanned document.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. sourceDocument
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| valueReference | Reference(DocumentReference) | There are no (further) constraints on this element Data type | ||
| sourceField | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField The name of the field within the source document where this sex or gender property is initially recorded. Alternate namesextensions, user content DefinitionThe name of the field within the source document where this sex or gender property is initially recorded. For example, if a sex value is acquired from a driver's license, and the name of the field on that driver's license is 'SEX', then a code describing that field can be provided. If the semantics of the field are known, they may be described in the comment. For example, if the 'SEX' field on a license in a particular state or province is populated based on an individual's indication of what gender they consider themselves to be, but the field label is 'SEX' for historical reasons, a comment describing that the semantics of the field align with gender identity, even though the field name is 'SEX' can be provided.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. sourceField
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | There are no (further) constraints on this element Data type | ||
| jurisdiction | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction Who issued the document where the sex or gender was aquired Alternate namesextensions, user content DefinitionThe jurisdiction or organization that issued the document from which the sex or gender was aquired For example, a individual's driver's license or passport would be issued by a specific state or country.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. jurisdiction
| |
| value[x] | 1..1 | Binding | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). http://terminology.hl7.org/ValueSet/jurisdiction (extensible) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| comment | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment Context or source information about the recorded sex or gender Alternate namesextensions, user content DefinitionFurther explanation about the context or source of the recorded sex or gender value 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. comment
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | There are no (further) constraints on this element Data type | ||
| genderElementQualifier | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier Whether this recorded sex or gender value qualifies the .gender element. Alternate namesextensions, user content DefinitionInstances of the individual-recordedSexOrGender extension with this value set to 'true' provides additional semantics or provenance of the data communicated in the relevant '.gender' property in the resource. For example, if a system populates Patient.gender using a sex assigned at birth value, the individual-recordedSexOrGender extension with genderElementQualifier=true can provide that context. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. genderElementQualifier
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
| |
| value[x] | 0..0 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | S Σ | 1..* | package/structuredefinition-profile-identifier-ca-baseline.json | There are no (further) constraints on this element Element idPatient.identifier An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Patients are almost always assigned specific numerical identifiers. This element employs the constraints on identifier put forth in the CA Baseline using a profiled data type. package/structuredefinition-profile-identifier-ca-baseline.json Sliced:Unordered, Open, by type(Pattern) Constraints
|
| (All Slices) | There are no (further) constraints on this element | |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. The slices provided below are examples of identifier types used by jurisdictions for patient summary. These are not required, and the slicing is open meaning that other types can be provided and used in an implementation. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier.value The value that is unique within the system. DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| JHN | S Σ | 1..* | Identifier | Element idPatient.identifier:JHN Jurisdictional Health Number DefinitionFederal patient and person health numbers used by all jurisdictions across Canada Patients are almost always assigned specific numerical identifiers. Patients must have at least an AB ULI identifier or another provincial JHN identifier. Implementers supplying ULIs shall use identifier.system of https://fhir.infoway-inforoute.ca/NamingSystem/ca-ab-patient-healthcare-id
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:JHN.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:JHN.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| versionCode | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.identifier:JHN.extension:versionCode Health Number Version Code Alternate namesextensions, user content DefinitionA code indicating a specific version of an identifier credential For example, a health card version number, credit card version number, etc. Used to help verify the authenticity of a credential http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier:JHN.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | S Σ | 1..1 | CodeableConceptBindingFixed Value | There are no (further) constraints on this element Element idPatient.identifier:JHN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "JHN"
}
]
}
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:JHN.system A Health Number Naming System from the Canadian URI Registry DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:JHN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:JHN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:JHN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| MRN | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier:MRN Medical Record Number DefinitionA local patient identifier from the submitting PoS System Patients are almost always assigned specific numerical identifiers. Some jurisdictions may consider the MRN identifier type to be an alternative to the JHN identifier type under certain scenarios. These business rules are outside the scope of this profile, however the slice is socialized to prepare implementers for potential use of this pattern within certain jurisdictions
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:MRN.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:MRN.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier:MRN.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 1..1 | CodeableConceptBindingFixed Value | There are no (further) constraints on this element Element idPatient.identifier:MRN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR"
}
]
}
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:MRN.system An identifier for the system supplying the MRN DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:MRN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:MRN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:MRN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.active Whether this patient's record is in active use DefinitionWhether 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. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. This resource is generally assumed to be active if no value is provided for the active element
|
| name | S Σ I | 1..* | HumanName | There are no (further) constraints on this element Element idPatient.name A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. The Alphabetic representation of the name SHALL be always provided 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
|
| text | S Σ | 1..1 | string | Element idPatient.name.text Text representation of the full name DefinitionText representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element A renderable, unencoded form. Mandatory String: Max Character length: 200
|
| family | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
| given | S Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
|
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefix Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffix Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| telecom | S Σ I | 0..* | ContactPoint | Element idPatient.telecom A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Unordered, Open, by system(Pattern) Constraints
|
| Phone | S Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:Phone A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Phone.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:Phone.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | S Σ I | 1..1 | codeBindingFixed Value | Element idPatient.telecom:Phone.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
phone
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Phone.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom:Phone.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:Phone.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:Phone.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. 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. The gender of a person used for administrative purposes.
|
| birthDate | S Σ | 1..1 | date | There are no (further) constraints on this element Element idPatient.birthDate The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. While the birthDate element requires a value, if the exact date of birth is unknown, only the known portion of the date (e.g., the year) should be provided without estimating or inferring unknown parts of the date. Use of the Data Absent Reason is appropriate when the date of birth of an individual cannot be determined.
|
| deceased[x] | Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. 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. 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.
| |
| deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
| deceasedDateTime | dateTime | There are no (further) constraints on this element Data type | ||
| address | S Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.address An address for the individual DefinitionAn address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | Element idPatient.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Assumed to be current home address if Address is present but no Use value is provided The use of an address.
General home Mappings
|
| type | Σ | 0..1 | codeBinding | Element idPatient.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Valid values: postal / physical / both. Assumed to be 'both' if no value is provided The type of an address (physical / postal).
General both Mappings
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
| line | S Σ | 1..* | string | There are no (further) constraints on this element Element idPatient.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
| city | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
| district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
| state | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
| postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
| country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
|
| maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The domestic partnership status of a person.
| |
| multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. 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).
| ||
| multipleBirthBoolean | boolean | There are no (further) constraints on this element Data type | ||
| multipleBirthInteger | integer | There are no (further) constraints on this element Data type | ||
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
|
| contact | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and a contact person for that patient.
| |
| name | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.name A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. 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.
| |
| telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
| address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.address Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited. 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).
| |
| gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes.
| |
| organization | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| period | I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.period The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communication A language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health. 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. 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| language | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. 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. A human language.
| |
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). 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. This language is specifically identified for communicating healthcare information.
| |
| generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Reference(Organization | Practitioner | PractitionerRole) Constraints
|
| managingOrganization | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. 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).
|
| link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| other | Σ I | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.other The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) Constraints
|
| type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.type replaced-by | replaces | refer | seealso DefinitionThe type of link between this patient resource and another patient resource. Note that FHIR strings SHALL NOT exceed 1MB in size The type of link between this patient resource and another patient resource.
|
| Patient | I | Patient | Element idPatient Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services. Patient resources included in Alberta Patient Summary Document Bundles have rules that certain attributes are not to be contained in Patient resource. These are mechanically enforced through invariants at the PS-AB Bundle level.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Metadata about the resource DefinitionThe 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.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
| extension | I | 1..* | Extension | There are no (further) constraints on this element Element idPatient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| individual-recordedSexOrGender | S I | 1..* | Extension(Complex) | Element idPatient.extension:individual-recordedSexOrGender Extension for representing an individuals recorded sex or gender. Alternate namesextensions, user content DefinitionRecorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| value | I | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value The recorded sex or gender property for the individual Alternate namesextensions, user content DefinitionA sex or gender property for the individual from a document or other record 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. value
| |
| value[x] | 1..1 | Binding | Element idPatient.extension:individual-recordedSexOrGender.extension:value.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). package/ValueSet-administrative-gender-ab.json (required) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| type | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type Type of recorded sex or gender. Alternate namesextensions, user content DefinitionThe type or category of sex or gender that is recorded. Because the recorded sex or gender concept exists primarily as means to exchange sex and gender data concepts that are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, the type is used to identify what type of concept the recorded sex or gender concept is.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. type
| |
| value[x] | 1..1 | Binding | Element idPatient.extension:individual-recordedSexOrGender.extension:type.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). package/ValueSet-recorded-sex-or-gender-type-AB.json (required) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| effectivePeriod | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod When the recorded sex or gender value applies Alternate namesextensions, user content DefinitionThe time period during which the recorded sex or gender value applies to the individual 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. effectivePeriod
| |
| value[x] | 0..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||
| acquisitionDate | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate When the sex or gender value was recorded. Alternate namesextensions, user content DefinitionThe date/time when the sex or gender value was first recorded in the system. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. acquisitionDate
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
| sourceDocument | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument The document the sex or gender property was acquired from. Alternate namesextensions, user content DefinitionThe reference to the source document or the code representing the type of document where this sex or gender property is initially recorded. For example, if a driver's license is scanned, this property may reference that scanned document.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. sourceDocument
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| valueReference | Reference(DocumentReference) | There are no (further) constraints on this element Data type | ||
| sourceField | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField The name of the field within the source document where this sex or gender property is initially recorded. Alternate namesextensions, user content DefinitionThe name of the field within the source document where this sex or gender property is initially recorded. For example, if a sex value is acquired from a driver's license, and the name of the field on that driver's license is 'SEX', then a code describing that field can be provided. If the semantics of the field are known, they may be described in the comment. For example, if the 'SEX' field on a license in a particular state or province is populated based on an individual's indication of what gender they consider themselves to be, but the field label is 'SEX' for historical reasons, a comment describing that the semantics of the field align with gender identity, even though the field name is 'SEX' can be provided.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. sourceField
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | There are no (further) constraints on this element Data type | ||
| jurisdiction | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction Who issued the document where the sex or gender was aquired Alternate namesextensions, user content DefinitionThe jurisdiction or organization that issued the document from which the sex or gender was aquired For example, a individual's driver's license or passport would be issued by a specific state or country.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. jurisdiction
| |
| value[x] | 1..1 | Binding | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). http://terminology.hl7.org/ValueSet/jurisdiction (extensible) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| comment | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment Context or source information about the recorded sex or gender Alternate namesextensions, user content DefinitionFurther explanation about the context or source of the recorded sex or gender value 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. comment
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | There are no (further) constraints on this element Data type | ||
| genderElementQualifier | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier Whether this recorded sex or gender value qualifies the .gender element. Alternate namesextensions, user content DefinitionInstances of the individual-recordedSexOrGender extension with this value set to 'true' provides additional semantics or provenance of the data communicated in the relevant '.gender' property in the resource. For example, if a system populates Patient.gender using a sex assigned at birth value, the individual-recordedSexOrGender extension with genderElementQualifier=true can provide that context. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. genderElementQualifier
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
| |
| value[x] | 0..0 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | S Σ | 1..* | package/structuredefinition-profile-identifier-ca-baseline.json | There are no (further) constraints on this element Element idPatient.identifier An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Patients are almost always assigned specific numerical identifiers. This element employs the constraints on identifier put forth in the CA Baseline using a profiled data type. package/structuredefinition-profile-identifier-ca-baseline.json Sliced:Unordered, Open, by type(Pattern) Constraints
|
| (All Slices) | There are no (further) constraints on this element | |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. The slices provided below are examples of identifier types used by jurisdictions for patient summary. These are not required, and the slicing is open meaning that other types can be provided and used in an implementation. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier.value The value that is unique within the system. DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| JHN | S Σ | 1..* | Identifier | Element idPatient.identifier:JHN Jurisdictional Health Number DefinitionFederal patient and person health numbers used by all jurisdictions across Canada Patients are almost always assigned specific numerical identifiers. Patients must have at least an AB ULI identifier or another provincial JHN identifier. Implementers supplying ULIs shall use identifier.system of https://fhir.infoway-inforoute.ca/NamingSystem/ca-ab-patient-healthcare-id
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:JHN.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:JHN.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| versionCode | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.identifier:JHN.extension:versionCode Health Number Version Code Alternate namesextensions, user content DefinitionA code indicating a specific version of an identifier credential For example, a health card version number, credit card version number, etc. Used to help verify the authenticity of a credential http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier:JHN.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | S Σ | 1..1 | CodeableConceptBindingFixed Value | There are no (further) constraints on this element Element idPatient.identifier:JHN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "JHN"
}
]
}
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:JHN.system A Health Number Naming System from the Canadian URI Registry DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:JHN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:JHN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:JHN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| MRN | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier:MRN Medical Record Number DefinitionA local patient identifier from the submitting PoS System Patients are almost always assigned specific numerical identifiers. Some jurisdictions may consider the MRN identifier type to be an alternative to the JHN identifier type under certain scenarios. These business rules are outside the scope of this profile, however the slice is socialized to prepare implementers for potential use of this pattern within certain jurisdictions
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:MRN.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:MRN.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier:MRN.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 1..1 | CodeableConceptBindingFixed Value | There are no (further) constraints on this element Element idPatient.identifier:MRN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR"
}
]
}
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:MRN.system An identifier for the system supplying the MRN DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:MRN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:MRN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:MRN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.active Whether this patient's record is in active use DefinitionWhether 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. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. This resource is generally assumed to be active if no value is provided for the active element
|
| name | S Σ I | 1..* | HumanName | There are no (further) constraints on this element Element idPatient.name A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. The Alphabetic representation of the name SHALL be always provided 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
|
| text | S Σ | 1..1 | string | Element idPatient.name.text Text representation of the full name DefinitionText representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element A renderable, unencoded form. Mandatory String: Max Character length: 200
|
| family | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
| given | S Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
|
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefix Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffix Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| telecom | S Σ I | 0..* | ContactPoint | Element idPatient.telecom A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Unordered, Open, by system(Pattern) Constraints
|
| Phone | S Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:Phone A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Phone.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:Phone.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | S Σ I | 1..1 | codeBindingFixed Value | Element idPatient.telecom:Phone.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
phone
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Phone.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom:Phone.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:Phone.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:Phone.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. 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. The gender of a person used for administrative purposes.
|
| birthDate | S Σ | 1..1 | date | There are no (further) constraints on this element Element idPatient.birthDate The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. While the birthDate element requires a value, if the exact date of birth is unknown, only the known portion of the date (e.g., the year) should be provided without estimating or inferring unknown parts of the date. Use of the Data Absent Reason is appropriate when the date of birth of an individual cannot be determined.
|
| deceased[x] | Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. 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. 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.
| |
| deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
| deceasedDateTime | dateTime | There are no (further) constraints on this element Data type | ||
| address | S Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.address An address for the individual DefinitionAn address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | Element idPatient.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Assumed to be current home address if Address is present but no Use value is provided The use of an address.
General home Mappings
|
| type | Σ | 0..1 | codeBinding | Element idPatient.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Valid values: postal / physical / both. Assumed to be 'both' if no value is provided The type of an address (physical / postal).
General both Mappings
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
| line | S Σ | 1..* | string | There are no (further) constraints on this element Element idPatient.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
| city | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
| district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
| state | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
| postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
| country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
|
| maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The domestic partnership status of a person.
| |
| multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. 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).
| ||
| multipleBirthBoolean | boolean | There are no (further) constraints on this element Data type | ||
| multipleBirthInteger | integer | There are no (further) constraints on this element Data type | ||
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
|
| contact | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and a contact person for that patient.
| |
| name | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.name A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. 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.
| |
| telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
| address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.address Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited. 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).
| |
| gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes.
| |
| organization | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| period | I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.period The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communication A language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health. 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. 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| language | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. 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. A human language.
| |
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). 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. This language is specifically identified for communicating healthcare information.
| |
| generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Reference(Organization | Practitioner | PractitionerRole) Constraints
|
| managingOrganization | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. 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).
|
| link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| other | Σ I | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.other The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) Constraints
|
| type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.type replaced-by | replaces | refer | seealso DefinitionThe type of link between this patient resource and another patient resource. Note that FHIR strings SHALL NOT exceed 1MB in size The type of link between this patient resource and another patient resource.
|
| Patient | I | Patient | Element idPatient Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services. Patient resources included in Alberta Patient Summary Document Bundles have rules that certain attributes are not to be contained in Patient resource. These are mechanically enforced through invariants at the PS-AB Bundle level.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Metadata about the resource DefinitionThe 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.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
| extension | I | 1..* | Extension | There are no (further) constraints on this element Element idPatient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| individual-recordedSexOrGender | S I | 1..* | Extension(Complex) | Element idPatient.extension:individual-recordedSexOrGender Extension for representing an individuals recorded sex or gender. Alternate namesextensions, user content DefinitionRecorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| value | I | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value The recorded sex or gender property for the individual Alternate namesextensions, user content DefinitionA sex or gender property for the individual from a document or other record 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:value.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. value
| |
| value[x] | 1..1 | Binding | Element idPatient.extension:individual-recordedSexOrGender.extension:value.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). package/ValueSet-administrative-gender-ab.json (required) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| type | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type Type of recorded sex or gender. Alternate namesextensions, user content DefinitionThe type or category of sex or gender that is recorded. Because the recorded sex or gender concept exists primarily as means to exchange sex and gender data concepts that are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, the type is used to identify what type of concept the recorded sex or gender concept is.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:type.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. type
| |
| value[x] | 1..1 | Binding | Element idPatient.extension:individual-recordedSexOrGender.extension:type.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). package/ValueSet-recorded-sex-or-gender-type-AB.json (required) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| effectivePeriod | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod When the recorded sex or gender value applies Alternate namesextensions, user content DefinitionThe time period during which the recorded sex or gender value applies to the individual 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. effectivePeriod
| |
| value[x] | 0..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:effectivePeriod.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||
| acquisitionDate | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate When the sex or gender value was recorded. Alternate namesextensions, user content DefinitionThe date/time when the sex or gender value was first recorded in the system. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. acquisitionDate
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:acquisitionDate.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
| sourceDocument | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument The document the sex or gender property was acquired from. Alternate namesextensions, user content DefinitionThe reference to the source document or the code representing the type of document where this sex or gender property is initially recorded. For example, if a driver's license is scanned, this property may reference that scanned document.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. sourceDocument
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceDocument.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| valueReference | Reference(DocumentReference) | There are no (further) constraints on this element Data type | ||
| sourceField | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField The name of the field within the source document where this sex or gender property is initially recorded. Alternate namesextensions, user content DefinitionThe name of the field within the source document where this sex or gender property is initially recorded. For example, if a sex value is acquired from a driver's license, and the name of the field on that driver's license is 'SEX', then a code describing that field can be provided. If the semantics of the field are known, they may be described in the comment. For example, if the 'SEX' field on a license in a particular state or province is populated based on an individual's indication of what gender they consider themselves to be, but the field label is 'SEX' for historical reasons, a comment describing that the semantics of the field align with gender identity, even though the field name is 'SEX' can be provided.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. sourceField
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:sourceField.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | There are no (further) constraints on this element Data type | ||
| jurisdiction | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction Who issued the document where the sex or gender was aquired Alternate namesextensions, user content DefinitionThe jurisdiction or organization that issued the document from which the sex or gender was aquired For example, a individual's driver's license or passport would be issued by a specific state or country.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. jurisdiction
| |
| value[x] | 1..1 | Binding | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:jurisdiction.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). http://terminology.hl7.org/ValueSet/jurisdiction (extensible) Constraints
| |
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| comment | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment Context or source information about the recorded sex or gender Alternate namesextensions, user content DefinitionFurther explanation about the context or source of the recorded sex or gender value 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. comment
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:comment.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | There are no (further) constraints on this element Data type | ||
| genderElementQualifier | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier Whether this recorded sex or gender value qualifies the .gender element. Alternate namesextensions, user content DefinitionInstances of the individual-recordedSexOrGender extension with this value set to 'true' provides additional semantics or provenance of the data communicated in the relevant '.gender' property in the resource. For example, if a system populates Patient.gender using a sex assigned at birth value, the individual-recordedSexOrGender extension with genderElementQualifier=true can provide that context. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. genderElementQualifier
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.extension:genderElementQualifier.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
| |
| value[x] | 0..0 | There are no (further) constraints on this element Element idPatient.extension:individual-recordedSexOrGender.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | S Σ | 1..* | package/structuredefinition-profile-identifier-ca-baseline.json | There are no (further) constraints on this element Element idPatient.identifier An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Patients are almost always assigned specific numerical identifiers. This element employs the constraints on identifier put forth in the CA Baseline using a profiled data type. package/structuredefinition-profile-identifier-ca-baseline.json Sliced:Unordered, Open, by type(Pattern) Constraints
|
| (All Slices) | There are no (further) constraints on this element | |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. The slices provided below are examples of identifier types used by jurisdictions for patient summary. These are not required, and the slicing is open meaning that other types can be provided and used in an implementation. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier.value The value that is unique within the system. DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| JHN | S Σ | 1..* | Identifier | Element idPatient.identifier:JHN Jurisdictional Health Number DefinitionFederal patient and person health numbers used by all jurisdictions across Canada Patients are almost always assigned specific numerical identifiers. Patients must have at least an AB ULI identifier or another provincial JHN identifier. Implementers supplying ULIs shall use identifier.system of https://fhir.infoway-inforoute.ca/NamingSystem/ca-ab-patient-healthcare-id
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:JHN.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:JHN.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| versionCode | I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.identifier:JHN.extension:versionCode Health Number Version Code Alternate namesextensions, user content DefinitionA code indicating a specific version of an identifier credential For example, a health card version number, credit card version number, etc. Used to help verify the authenticity of a credential http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier:JHN.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | S Σ | 1..1 | CodeableConceptBindingFixed Value | There are no (further) constraints on this element Element idPatient.identifier:JHN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "JHN"
}
]
}
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:JHN.system A Health Number Naming System from the Canadian URI Registry DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:JHN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:JHN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:JHN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| MRN | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier:MRN Medical Record Number DefinitionA local patient identifier from the submitting PoS System Patients are almost always assigned specific numerical identifiers. Some jurisdictions may consider the MRN identifier type to be an alternative to the JHN identifier type under certain scenarios. These business rules are outside the scope of this profile, however the slice is socialized to prepare implementers for potential use of this pattern within certain jurisdictions
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:MRN.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:MRN.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier:MRN.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 1..1 | CodeableConceptBindingFixed Value | There are no (further) constraints on this element Element idPatient.identifier:MRN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR"
}
]
}
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:MRN.system An identifier for the system supplying the MRN DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:MRN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:MRN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:MRN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.active Whether this patient's record is in active use DefinitionWhether 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. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. This resource is generally assumed to be active if no value is provided for the active element
|
| name | S Σ I | 1..* | HumanName | There are no (further) constraints on this element Element idPatient.name A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. The Alphabetic representation of the name SHALL be always provided 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
|
| text | S Σ | 1..1 | string | Element idPatient.name.text Text representation of the full name DefinitionText representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element A renderable, unencoded form. Mandatory String: Max Character length: 200
|
| family | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
| given | S Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
|
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefix Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffix Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| telecom | S Σ I | 0..* | ContactPoint | Element idPatient.telecom A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Unordered, Open, by system(Pattern) Constraints
|
| Phone | S Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:Phone A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Phone.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:Phone.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | S Σ I | 1..1 | codeBindingFixed Value | Element idPatient.telecom:Phone.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
phone
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:Phone.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom:Phone.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:Phone.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:Phone.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. 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. The gender of a person used for administrative purposes.
|
| birthDate | S Σ | 1..1 | date | There are no (further) constraints on this element Element idPatient.birthDate The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. While the birthDate element requires a value, if the exact date of birth is unknown, only the known portion of the date (e.g., the year) should be provided without estimating or inferring unknown parts of the date. Use of the Data Absent Reason is appropriate when the date of birth of an individual cannot be determined.
|
| deceased[x] | Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. 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. 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.
| |
| deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
| deceasedDateTime | dateTime | There are no (further) constraints on this element Data type | ||
| address | S Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.address An address for the individual DefinitionAn address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | Element idPatient.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Assumed to be current home address if Address is present but no Use value is provided The use of an address.
General home Mappings
|
| type | Σ | 0..1 | codeBinding | Element idPatient.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Valid values: postal / physical / both. Assumed to be 'both' if no value is provided The type of an address (physical / postal).
General both Mappings
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
| line | S Σ | 1..* | string | There are no (further) constraints on this element Element idPatient.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
| city | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
| district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
| state | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
| postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
| country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
|
| maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The domestic partnership status of a person.
| |
| multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. 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).
| ||
| multipleBirthBoolean | boolean | There are no (further) constraints on this element Data type | ||
| multipleBirthInteger | integer | There are no (further) constraints on this element Data type | ||
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
|
| contact | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and a contact person for that patient.
| |
| name | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.name A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. 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.
| |
| telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
| address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.address Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited. 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).
| |
| gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes.
| |
| organization | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| period | I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.period The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communication A language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health. 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. 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| language | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. 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. A human language.
| |
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). 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. This language is specifically identified for communicating healthcare information.
| |
| generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Reference(Organization | Practitioner | PractitionerRole) Constraints
|
| managingOrganization | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. 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).
|
| link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| other | Σ I | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.other The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) Constraints
|
| type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.type replaced-by | replaces | refer | seealso DefinitionThe type of link between this patient resource and another patient resource. Note that FHIR strings SHALL NOT exceed 1MB in size The type of link between this patient resource and another patient resource.
|
Restrictions
Alberta Patient Summary (PS-AB) employs a set of constraints on the package/StructureDefinition-BundlePSAB.json Profile that prevents patient summaries created in Alberta to include certain elements from Patient.
Patient records sent in a PS-AB Bundle SHALL NOT contain any of the following Patient details:
- .text
- .active
- .address.text
- .maritalStatus
- .multipleBirth
- .photo
- .contact.gender
- .contact.organization
- .contact.period
- .generalPractitioner
- .managingOrganization
These elements are restricted based on current privacy requirements that require data that is collected, used or disclosed be limited to only the amount of health information that is essential to enable the custodian or the recipient of the information to carry out the intended purpose.
Usage
The Patient Resource is used to provide information about the person who is the subject of a patient summary in its header
.id
- used to uniquely identify the resource
- if a persistent identity for the resource is not available to use when constructing a Bundle for transmission, a UUID SHOULD be used in this element (with a corresponding value in
Bundle.entry.fullUrl)
.identifier
- SHALL have at least one identifier
- Alberta Unique Lifetime Identifier (ULI) SHOULD be provided when available.
- the patient's health care number from another jurisdiction SHALL be provided if the patient is from outside the province and does not have a ULI
- each identifier SHALL always have the associated
.system,.typeand.valuepopulated .valuemaximum character length SHALL be 20.systemSHALL use URI from Patient Identifier Naming System, and SHALL use the associated identifier type code for.type, and the associated assigning authority name forassigner.display
.name
- SHALL have at least one name
- at least one name SHALL match the registered name in the Alberta provincial insurance
.textSHALL alway be populated. It is the patient's full name in the format that would be used for communications or correspondence with the patient. It MAY include a preferred name in addition to or instead of a legal given name. Maximum character length SHALL be 200..familySHALL always be populated
.telecom
- preferred telephone number for the subject patient. Email address is NOT collected for communications purposes as email is not an acceptable method for communicating confidential / clinical information
- SHALL have at least one
.telecom:Phoneenforced by an invariant in Bundle resource
.gender
- SHALL always be set to
"other"and the actual value SHALL be placed in .individual-recordedSexOrGender extension
.birthDate
- SHALL always be populated
.address
- SHALL have at least one address
useSHALL be assumed as"home"when not valuedtypeSHALL be assumed as"both"(i.e.,"physical"and"postal") when not valued- SHALL have at least one
.line .city,.state, and.postalCodeSHALL always be populated.stateSHALL use code from Canada Post Province & State Code.countrySHALL use code from ISO 3166-3 Character Country Code
.communication
.language.coding.codeSHALL use ISO 639-3. Codes are available from SIL International (registration autority for ISO 639-3).language.coding.systemSHALL use "http://terminology.hl7.org/CodeSystem/iso639-3"
Extensions
.individual-recordedSexOrGender
- administrative gender used for verifying patient identity
- SHALL always be populated
.valueSHALL always be populated and SHALL use code from AdministrativeGender_AB value set package/ValueSet-administrative-gender-ab.json