This is Snapshot #3 for FHIR R5, released to support Connectathon 32. For a full list of available versions, see the Directory of published versions.
Patient Administration Work Group | Maturity Level: 1 | Trial Use | Use Context: Any |
Detailed Descriptions for the elements in the extension.
Extension | |||||||||||||
Element Id | Extension | ||||||||||||
Definition | A sex or gender property for the individual from a document or other record | ||||||||||||
Short Display | A recorded sex or gender property for the individual | ||||||||||||
Cardinality | 0..* | ||||||||||||
Invariants |
| ||||||||||||
Extension.id | |||||||||||||
Element Id | Extension.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension | |||||||||||||
Element Id | Extension.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension(value) | |||||||||||||
Element Id | Extension.extension:value | ||||||||||||
Definition | A sex or gender property for the individual from a document or other record | ||||||||||||
Short Display | The recorded sex or gender property for the individual | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:value.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:value.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:value.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | value | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:value.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | null For example codes, see AdministrativeGender | ||||||||||||
Type | CodeableConcept | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(internationalEquivalent) | |||||||||||||
Element Id | Extension.extension:internationalEquivalent | ||||||||||||
Definition | An international representation of the value found on the document for interoperability and international legal purposes. | ||||||||||||
Short Display | An international representation of the value found on the document | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:internationalEquivalent.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:internationalEquivalent.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:internationalEquivalent.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | internationalEquivalent | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:internationalEquivalent.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | null The codes SHALL be taken from International Civil Aviation Organization Sex Or Gender; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(type) | |||||||||||||
Element Id | Extension.extension:type | ||||||||||||
Definition | The type or category of sex or gender that is recorded. | ||||||||||||
Short Display | Type of recorded sex or gender. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | Because the recorded sex and gender concept exists primarily as means to exchange sex and gender data concepts that are either use-case specific or that are historically not well defined, the type may either imply the indended use of the sex or gender value, or identify the sex or gender value as based on historical semanitcs. | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:type.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:type.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:type.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | type | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:type.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | null The codes SHOULD be taken from Recorded Sex Or Gender Type | ||||||||||||
Type | CodeableConcept | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(effectivePeriod) | |||||||||||||
Element Id | Extension.extension:effectivePeriod | ||||||||||||
Definition | The time period during which the recorded sex or gender value applies to the individual | ||||||||||||
Short Display | When the recorded sex or gender value applies | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:effectivePeriod.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:effectivePeriod.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:effectivePeriod.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | effectivePeriod | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:effectivePeriod.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Period | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(acquisitionDate) | |||||||||||||
Element Id | Extension.extension:acquisitionDate | ||||||||||||
Definition | The date/time when the sex or gender value was first recorded in the system. | ||||||||||||
Short Display | When the sex or gender value was recorded. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:acquisitionDate.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:acquisitionDate.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:acquisitionDate.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | acquisitionDate | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:acquisitionDate.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | dateTime | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(sourceDocument) | |||||||||||||
Element Id | Extension.extension:sourceDocument | ||||||||||||
Definition | The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded. | ||||||||||||
Short Display | The document the sex or gender property was acquired from. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | For example, if a driver's license is scanned, this property may reference that scanned document. | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:sourceDocument.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:sourceDocument.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:sourceDocument.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | sourceDocument | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:sourceDocument.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | CodeableReference(DocumentReference) | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(sourceField) | |||||||||||||
Element Id | Extension.extension:sourceField | ||||||||||||
Definition | The name of the field within the source document where this sex or gender property is initially recorded. | ||||||||||||
Short Display | The name of the field within the source document where this sex or gender property is initially recorded. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | 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. | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:sourceField.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:sourceField.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:sourceField.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | sourceField | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:sourceField.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(jurisdiction) | |||||||||||||
Element Id | Extension.extension:jurisdiction | ||||||||||||
Definition | The jurisdiction or organization that issued the document from which the sex or gender was aquired | ||||||||||||
Short Display | Who issued the document where the sex or gender was aquired | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | For example, a individual's driver's license or passport would be issued by a specific state or country. | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:jurisdiction.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:jurisdiction.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:jurisdiction.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | jurisdiction | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:jurisdiction.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | null The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(comment) | |||||||||||||
Element Id | Extension.extension:comment | ||||||||||||
Definition | Further explanation about the context or source of the recorded sex or gender value | ||||||||||||
Short Display | Context or source information about the recorded sex or gender | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:comment.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:comment.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:comment.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | comment | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:comment.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.url | |||||||||||||
Element Id | Extension.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||
Fixed Value | http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||||||||
Extension.value[x] | |||||||||||||
Element Id | Extension.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
|