AU Core Implementation Guide
2.0.0-ci-build - CI Build
AU Core Implementation Guide
2.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the au-core-rsg-sexassignedab extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |||||||
| Definition | Sex assigned at birth refers to what was determined by biological sex characteristics including genital and chromosome composition observed at birth or infancy. Sex assigned at birth is captured once for a person and is not expected to change within their lifetime. Optional Extension Element - found in all resources. | ||||||
| Short | Sex Assigned at BirthOptional Extensions Element | ||||||
| Comments | A person's sex can change over the course of their lifetime. The value in sex assigned at birth may not match a person’s gender or the sex recorded on their birth certificate or values in observations taken later in life that are the result of a specific measurement e.g. gonadal, ductal or phenotypic. | ||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
| Is Modifier | false | ||||||
| Alternate Names | Birth sex, Natal sex | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 2. 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 managable, 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. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | Additional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 20..* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 4. Extension.extension:value | |||||||
| Slice Name | value | ||||||
| Definition | An Extension | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Control | 10..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 6. Extension.extension:value.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 8. Extension.extension:value.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | value | ||||||
| 10. 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). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see Biological Sex  (extensible to https://healthterminologies.gov.au/fhir/ValueSet/biological-sex-1) | ||||||
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 12. Extension.extension:type | |||||||
| Slice Name | type | ||||||
| Definition | The type or category of sex or gender that is recorded is sex assigned at birth. | ||||||
| Short | SNOMED Sex Assigned at BirthAdditional content defined by implementations | ||||||
| Comments | 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. | ||||||
| Control | 10..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 14. Extension.extension:type.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 16. Extension.extension:type.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | type | ||||||
| 18. 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). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Binding | For example codes, see For codes, see Recorded Sex Or Gender Type (example to http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type) | ||||||
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Pattern Value | { | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 20. Extension.extension:effectivePeriod | |||||||
| Slice Name | effectivePeriod | ||||||
| Definition | The time period during which the recorded sex or gender value applies to the individual | ||||||
| Short | When the recorded sex or gender value appliesAdditional content defined by implementations | ||||||
| Control | 0..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 22. Extension.extension:effectivePeriod.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 24. Extension.extension:effectivePeriod.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | effectivePeriod | ||||||
| 26. Extension.extension:acquisitionDate | |||||||
| Slice Name | acquisitionDate | ||||||
| Definition | The date/time when the sex or gender value was first recorded in the system. | ||||||
| Short | When the sex or gender value was recorded.Additional content defined by implementations | ||||||
| Control | 0..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 28. Extension.extension:acquisitionDate.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 30. Extension.extension:acquisitionDate.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | acquisitionDate | ||||||
| 32. 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). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | dateTime, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 34. Extension.extension:source | |||||||
| Slice Name | source | ||||||
| Definition | A reference to the source of the Recorded Sex or Gender value. | ||||||
| Short | The source of the Recorded Sex or Gender value.Additional content defined by implementations | ||||||
| Comments | Unlike the sourceDocument element, this element can reference non-document sources including applications, organisations or individuals. For example, if the Recored Sex or Gender value is recorded in a national patient identifier system this element may reference that system. This element can also be the source of the document referred to in the sourceDocument element. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system. | ||||||
| Control | 0..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 36. Extension.extension:source.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 38. Extension.extension:source.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | source | ||||||
| 40. Extension.extension:source.value[x] | |||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | Choice of: CodeableConcept, Reference(Organization, Device, RelatedPerson, Practitioner), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 42. Extension.extension:sourceDocument | |||||||
| Slice Name | 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 | The document the sex or gender property was acquired from.Additional content defined by implementations | ||||||
| Comments | For example, if a driver's license is scanned, this property may reference that scanned document. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system. | ||||||
| Control | 0..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 44. Extension.extension:sourceDocument.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 46. Extension.extension:sourceDocument.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | sourceDocument | ||||||
| 48. 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). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | Choice of: CodeableConcept, Reference(DocumentReference), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 50. Extension.extension:sourceField | |||||||
| Slice Name | sourceField | ||||||
| Definition | The name of the field within the source document where this sex or gender property is initially recorded. | ||||||
| Short | The name of the field within the source document where this sex or gender property is initially recorded.Additional content defined by implementations | ||||||
| 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. | ||||||
| Control | 0..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 52. Extension.extension:sourceField.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 54. Extension.extension:sourceField.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | sourceField | ||||||
| 56. 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). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 58. Extension.extension:jurisdiction | |||||||
| Slice Name | jurisdiction | ||||||
| Definition | Jurisdiction responsible for the source and/or the sourceDocument where the recored sex or gender value was acquired. | ||||||
| Short | Who issued the document where the sex or gender was aquiredAdditional content defined by implementations | ||||||
| Comments | For example, a individual's driver's license or passport would be issued by a specific state or country. | ||||||
| Control | 0..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 60. Extension.extension:jurisdiction.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 62. Extension.extension:jurisdiction.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | jurisdiction | ||||||
| 64. 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). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see Jurisdiction ValueSet (extensible to http://terminology.hl7.org/ValueSet/jurisdiction) | ||||||
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 66. Extension.extension:comment | |||||||
| Slice Name | comment | ||||||
| Definition | Further explanation about the context or source of the recorded sex or gender value | ||||||
| Short | Context or source information about the recorded sex or genderAdditional content defined by implementations | ||||||
| Control | 0..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 68. Extension.extension:comment.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 70. Extension.extension:comment.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | comment | ||||||
| 72. 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). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 74. Extension.extension:genderElementQualifier | |||||||
| Slice Name | genderElementQualifier | ||||||
| Definition | Instances 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. | ||||||
| Short | Whether this recorded sex or gender value qualifies the .gender element.Additional content defined by implementations | ||||||
| Control | 0..1* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 76. Extension.extension:genderElementQualifier.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 78. Extension.extension:genderElementQualifier.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | genderElementQualifier | ||||||
| 80. Extension.extension:genderElementQualifier.value[x] | |||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | boolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 82. Extension.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
| 84. Extension.value[x] | |||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 0..01 This element is affected by the following invariants: ext-1 | ||||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta, Contributor | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |||||||
| Definition | Sex assigned at birth refers to what was determined by biological sex characteristics including genital and chromosome composition observed at birth or infancy. Sex assigned at birth is captured once for a person and is not expected to change within their lifetime. | ||||||
| Short | Sex Assigned at Birth | ||||||
| Comments | A person's sex can change over the course of their lifetime. The value in sex assigned at birth may not match a person’s gender or the sex recorded on their birth certificate or values in observations taken later in life that are the result of a specific measurement e.g. gonadal, ductal or phenotypic. | ||||||
| Alternate Names | Birth sex, Natal sex | ||||||
| 2. Extension.extension:value | |||||||
| Slice Name | value | ||||||
| Control | 1..? | ||||||
| Type | Extension | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| 4. Extension.extension:value.value[x] | |||||||
| Control | 1..? | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from Biological Sex (extensible to https://healthterminologies.gov.au/fhir/ValueSet/biological-sex-1) | ||||||
| Type | CodeableConcept | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| 6. Extension.extension:type | |||||||
| Slice Name | type | ||||||
| Definition | The type or category of sex or gender that is recorded is sex assigned at birth. | ||||||
| Short | SNOMED Sex Assigned at Birth | ||||||
| Comments | 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. | ||||||
| Control | 1..1 | ||||||
| Type | Extension | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| 8. Extension.extension:type.value[x] | |||||||
| Control | 1..? | ||||||
| Type | CodeableConcept | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Pattern Value | { | ||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |||||||
| Definition | Sex assigned at birth refers to what was determined by biological sex characteristics including genital and chromosome composition observed at birth or infancy. Sex assigned at birth is captured once for a person and is not expected to change within their lifetime. | ||||||
| Short | Sex Assigned at Birth | ||||||
| Comments | A person's sex can change over the course of their lifetime. The value in sex assigned at birth may not match a person’s gender or the sex recorded on their birth certificate or values in observations taken later in life that are the result of a specific measurement e.g. gonadal, ductal or phenotypic. | ||||||
| Control | 0..* | ||||||
| Is Modifier | false | ||||||
| Alternate Names | Birth sex, Natal sex | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 2. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 4. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | Additional content defined by implementations | ||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
| Control | 2..* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 6. Extension.extension:value | |||||||
| Slice Name | value | ||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 1..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 8. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 10. Extension.extension:value.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 12. Extension.extension:value.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | value | ||||||
| 14. 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 | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from Biological Sex (extensible to https://healthterminologies.gov.au/fhir/ValueSet/biological-sex-1) | ||||||
| Type | CodeableConcept | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 16. Extension.extension:type | |||||||
| Slice Name | type | ||||||
| Definition | The type or category of sex or gender that is recorded is sex assigned at birth. | ||||||
| Short | SNOMED Sex Assigned at Birth | ||||||
| Comments | 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. | ||||||
| Control | 1..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 18. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 20. Extension.extension:type.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 22. Extension.extension:type.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | type | ||||||
| 24. 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 | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Binding | For example codes, see Recorded Sex Or Gender Type (example to http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type) | ||||||
| Type | CodeableConcept | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Pattern Value | { | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 26. Extension.extension:effectivePeriod | |||||||
| Slice Name | effectivePeriod | ||||||
| Definition | The time period during which the recorded sex or gender value applies to the individual | ||||||
| Short | When the recorded sex or gender value applies | ||||||
| Control | 0..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 28. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 30. Extension.extension:effectivePeriod.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 32. Extension.extension:effectivePeriod.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | effectivePeriod | ||||||
| 34. 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 | Value of extension | ||||||
| Control | 0..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | Period | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 36. Extension.extension:acquisitionDate | |||||||
| Slice Name | acquisitionDate | ||||||
| Definition | The date/time when the sex or gender value was first recorded in the system. | ||||||
| Short | When the sex or gender value was recorded. | ||||||
| Control | 0..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 38. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 40. Extension.extension:acquisitionDate.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 42. Extension.extension:acquisitionDate.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | acquisitionDate | ||||||
| 44. 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 | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | dateTime | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 46. Extension.extension:source | |||||||
| Slice Name | source | ||||||
| Definition | A reference to the source of the Recorded Sex or Gender value. | ||||||
| Short | The source of the Recorded Sex or Gender value. | ||||||
| Comments | Unlike the sourceDocument element, this element can reference non-document sources including applications, organisations or individuals. For example, if the Recored Sex or Gender value is recorded in a national patient identifier system this element may reference that system. This element can also be the source of the document referred to in the sourceDocument element. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system. | ||||||
| Control | 0..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 48. Extension.extension:source.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 50. Extension.extension:source.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 52. Extension.extension:source.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | source | ||||||
| 54. Extension.extension:source.value[x] | |||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | Choice of: CodeableConcept, Reference(Organization, Device, RelatedPerson, Practitioner) | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 56. Extension.extension:sourceDocument | |||||||
| Slice Name | 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 | The document the sex or gender property was acquired from. | ||||||
| Comments | For example, if a driver's license is scanned, this property may reference that scanned document. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system. | ||||||
| Control | 0..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 58. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 60. Extension.extension:sourceDocument.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 62. Extension.extension:sourceDocument.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | sourceDocument | ||||||
| 64. 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 | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | Choice of: CodeableConcept, Reference(DocumentReference) | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 66. Extension.extension:sourceField | |||||||
| Slice Name | sourceField | ||||||
| Definition | The name of the field within the source document where this sex or gender property is initially recorded. | ||||||
| Short | The name of the field within the source document where this sex or gender property is initially recorded. | ||||||
| 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. | ||||||
| Control | 0..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 68. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 70. Extension.extension:sourceField.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 72. Extension.extension:sourceField.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | sourceField | ||||||
| 74. 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 | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | string | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 76. Extension.extension:jurisdiction | |||||||
| Slice Name | jurisdiction | ||||||
| Definition | Jurisdiction responsible for the source and/or the sourceDocument where the recored sex or gender value was acquired. | ||||||
| Short | Who issued the document where the sex or gender was aquired | ||||||
| Comments | For example, a individual's driver's license or passport would be issued by a specific state or country. | ||||||
| Control | 0..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 78. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 80. Extension.extension:jurisdiction.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 82. Extension.extension:jurisdiction.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | jurisdiction | ||||||
| 84. 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 | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://terminology.hl7.org/ValueSet/jurisdiction) | ||||||
| Type | CodeableConcept | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 86. Extension.extension:comment | |||||||
| Slice Name | comment | ||||||
| Definition | Further explanation about the context or source of the recorded sex or gender value | ||||||
| Short | Context or source information about the recorded sex or gender | ||||||
| Control | 0..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 88. 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 | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 90. Extension.extension:comment.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 92. Extension.extension:comment.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | comment | ||||||
| 94. 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 | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | string | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 96. Extension.extension:genderElementQualifier | |||||||
| Slice Name | genderElementQualifier | ||||||
| Definition | Instances 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. | ||||||
| Short | Whether this recorded sex or gender value qualifies the .gender element. | ||||||
| Control | 0..1 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 98. Extension.extension:genderElementQualifier.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | Unique id for inter-element referencing | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 100. Extension.extension:genderElementQualifier.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 102. Extension.extension:genderElementQualifier.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | genderElementQualifier | ||||||
| 104. Extension.extension:genderElementQualifier.value[x] | |||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
| Type | boolean | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 106. Extension.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
| 108. Extension.value[x] | |||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Value of extension | ||||||
| Control | 0..0 This element is affected by the following invariants: ext-1 | ||||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#2.0.0-ci-build based on FHIR 4.0.1. Generated 2025-09-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change