Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-CatalogEntry resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Basic | |
| Definition | Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification. |
| Short | Resource for non-supported content |
| Control | 0..* |
| Alternate Names | Z-resource, Extension-resource, Custom-resource |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 2. Basic.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. Basic.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| 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 | 20..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Basic.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: The type of item - medication, device, service, protocol or other (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: The type of item - medication, device, service, protocol or other (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. Basic.extension:orderable | |
| Slice Name | orderable |
| Definition | R4: |
| Short | R4: Whether the entry represents an orderable item (new) |
| Comments | Element |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Whether the entry represents an orderable item (new)) (Extension Type: boolean) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. Basic.extension:referencedItem | |
| Slice Name | referencedItem |
| Definition | R4: |
| Short | R4: The item that is being defined (new) |
| Comments | Element |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: The item that is being defined (new)) (Extension Type: Reference(Cross-version Profile for R4.Medication for use in FHIR STU3, Medication, Cross-version Profile for R4.Device for use in FHIR STU3, Device, Cross-version Profile for R4.Organization for use in FHIR STU3, Organization, Cross-version Profile for R4.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R4.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R4.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R4.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R4.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R4.SpecimenDefinition for use in FHIR STU3, Basic, Cross-version Profile for R4.ObservationDefinition for use in FHIR STU3, Basic, Cross-version Profile for R4.Binary for use in FHIR STU3, Binary)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. Basic.extension:additionalIdentifier | |
| Slice Name | additionalIdentifier |
| Definition | R4: |
| Short | R4: Any additional identifier(s) for the catalog item, in the same granularity or concept (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Any additional identifier(s) for the catalog item, in the same granularity or concept (new)) (Extension Type: Identifier) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. Basic.extension:classification | |
| Slice Name | classification |
| Definition | R4: |
| Short | R4: Classification (category or class) of the item entry (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Classification (category or class) of the item entry (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. Basic.extension:status | |
| Slice Name | status |
| Definition | R4: |
| Short | R4: draft | active | retired | unknown (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: draft | active | retired | unknown (new)) (Extension Type: code) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. Basic.extension:validityPeriod | |
| Slice Name | validityPeriod |
| Definition | R4: |
| Short | R4: The time period in which this catalog entry is expected to be active (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: The time period in which this catalog entry is expected to be active (new)) (Extension Type: Period) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 20. Basic.extension:validTo | |
| Slice Name | validTo |
| Definition | R4: |
| Short | R4: The date until which this catalog entry is expected to be active (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: The date until which this catalog entry is expected to be active (new)) (Extension Type: dateTime) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 22. Basic.extension:lastUpdated | |
| Slice Name | lastUpdated |
| Definition | R4: |
| Short | R4: When was this catalog last updated (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: When was this catalog last updated (new)) (Extension Type: dateTime) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 24. Basic.extension:additionalCharacteristic | |
| Slice Name | additionalCharacteristic |
| Definition | R4: |
| Short | R4: Additional characteristics of the catalog entry (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Additional characteristics of the catalog entry (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 26. Basic.extension:additionalClassification | |
| Slice Name | additionalClassification |
| Definition | R4: |
| Short | R4: Additional classification of the catalog entry (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Additional classification of the catalog entry (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 28. Basic.extension:relatedEntry | |
| Slice Name | relatedEntry |
| Definition | R4: |
| Short | R4: An item that this catalog entry is related to (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: An item that this catalog entry is related to (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 30. Basic.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
| Short | Extensions that cannot be ignored |
| 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..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 32. Basic.code | |
| Definition | Identifies the 'type' of resource - equivalent to the resource name for other resources. |
| Short | Kind of Resource |
| Comments | Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because the it defines the meaning of the resource and cannot be ignored. |
| Control | 1..1 |
| Binding | For example codes, see Basic Resource Typeshttp://hl7.org/fhir/ValueSet/basic-resource-type|3.0.2 (example to http://hl7.org/fhir/ValueSet/basic-resource-type|3.0.2)Codes for identifying types of resources not yet defined by FHIR |
| Type | CodeableConcept |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Summary | true |
| Requirements | Must be able to distinguish different types of Basic resources. |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Basic | |
| 2. Basic.extension | |
| Control | 2..* |
| Slicing | This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Basic.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: The type of item - medication, device, service, protocol or other (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: The type of item - medication, device, service, protocol or other (new)) (Extension Type: CodeableConcept) |
| 6. Basic.extension:orderable | |
| Slice Name | orderable |
| Definition | R4: |
| Short | R4: Whether the entry represents an orderable item (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R4: Whether the entry represents an orderable item (new)) (Extension Type: boolean) |
| 8. Basic.extension:referencedItem | |
| Slice Name | referencedItem |
| Definition | R4: |
| Short | R4: The item that is being defined (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R4: The item that is being defined (new)) (Extension Type: Reference(Cross-version Profile for R4.Medication for use in FHIR STU3, Medication, Cross-version Profile for R4.Device for use in FHIR STU3, Device, Cross-version Profile for R4.Organization for use in FHIR STU3, Organization, Cross-version Profile for R4.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R4.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R4.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R4.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R4.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R4.SpecimenDefinition for use in FHIR STU3, Basic, Cross-version Profile for R4.ObservationDefinition for use in FHIR STU3, Basic, Cross-version Profile for R4.Binary for use in FHIR STU3, Binary)) |
| 10. Basic.extension:additionalIdentifier | |
| Slice Name | additionalIdentifier |
| Definition | R4: |
| Short | R4: Any additional identifier(s) for the catalog item, in the same granularity or concept (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Any additional identifier(s) for the catalog item, in the same granularity or concept (new)) (Extension Type: Identifier) |
| 12. Basic.extension:classification | |
| Slice Name | classification |
| Definition | R4: |
| Short | R4: Classification (category or class) of the item entry (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Classification (category or class) of the item entry (new)) (Extension Type: CodeableConcept) |
| 14. Basic.extension:status | |
| Slice Name | status |
| Definition | R4: |
| Short | R4: draft | active | retired | unknown (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: draft | active | retired | unknown (new)) (Extension Type: code) |
| 16. Basic.extension:validityPeriod | |
| Slice Name | validityPeriod |
| Definition | R4: |
| Short | R4: The time period in which this catalog entry is expected to be active (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: The time period in which this catalog entry is expected to be active (new)) (Extension Type: Period) |
| 18. Basic.extension:validTo | |
| Slice Name | validTo |
| Definition | R4: |
| Short | R4: The date until which this catalog entry is expected to be active (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: The date until which this catalog entry is expected to be active (new)) (Extension Type: dateTime) |
| 20. Basic.extension:lastUpdated | |
| Slice Name | lastUpdated |
| Definition | R4: |
| Short | R4: When was this catalog last updated (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: When was this catalog last updated (new)) (Extension Type: dateTime) |
| 22. Basic.extension:additionalCharacteristic | |
| Slice Name | additionalCharacteristic |
| Definition | R4: |
| Short | R4: Additional characteristics of the catalog entry (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Additional characteristics of the catalog entry (new)) (Extension Type: CodeableConcept) |
| 24. Basic.extension:additionalClassification | |
| Slice Name | additionalClassification |
| Definition | R4: |
| Short | R4: Additional classification of the catalog entry (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Additional classification of the catalog entry (new)) (Extension Type: CodeableConcept) |
| 26. Basic.extension:relatedEntry | |
| Slice Name | relatedEntry |
| Definition | R4: |
| Short | R4: An item that this catalog entry is related to (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: An item that this catalog entry is related to (new)) (Complex Extension) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Basic | |||||
| Definition | Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification. | ||||
| Short | Resource for non-supported content | ||||
| Control | 0..* | ||||
| Alternate Names | Z-resource, Extension-resource, Custom-resource | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 2. Basic.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. Basic.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. Basic.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. Basic.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. Basic.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. Basic.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. Basic.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 2..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. Basic.extension:type | |||||
| Slice Name | type | ||||
| Definition | R4: | ||||
| Short | R4: The type of item - medication, device, service, protocol or other (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: The type of item - medication, device, service, protocol or other (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. Basic.extension:orderable | |||||
| Slice Name | orderable | ||||
| Definition | R4: | ||||
| Short | R4: Whether the entry represents an orderable item (new) | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Whether the entry represents an orderable item (new)) (Extension Type: boolean) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. Basic.extension:referencedItem | |||||
| Slice Name | referencedItem | ||||
| Definition | R4: | ||||
| Short | R4: The item that is being defined (new) | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: The item that is being defined (new)) (Extension Type: Reference(Cross-version Profile for R4.Medication for use in FHIR STU3, Medication, Cross-version Profile for R4.Device for use in FHIR STU3, Device, Cross-version Profile for R4.Organization for use in FHIR STU3, Organization, Cross-version Profile for R4.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R4.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R4.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R4.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R4.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R4.SpecimenDefinition for use in FHIR STU3, Basic, Cross-version Profile for R4.ObservationDefinition for use in FHIR STU3, Basic, Cross-version Profile for R4.Binary for use in FHIR STU3, Binary)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. Basic.extension:additionalIdentifier | |||||
| Slice Name | additionalIdentifier | ||||
| Definition | R4: | ||||
| Short | R4: Any additional identifier(s) for the catalog item, in the same granularity or concept (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Any additional identifier(s) for the catalog item, in the same granularity or concept (new)) (Extension Type: Identifier) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. Basic.extension:classification | |||||
| Slice Name | classification | ||||
| Definition | R4: | ||||
| Short | R4: Classification (category or class) of the item entry (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Classification (category or class) of the item entry (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. Basic.extension:status | |||||
| Slice Name | status | ||||
| Definition | R4: | ||||
| Short | R4: draft | active | retired | unknown (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: draft | active | retired | unknown (new)) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 28. Basic.extension:validityPeriod | |||||
| Slice Name | validityPeriod | ||||
| Definition | R4: | ||||
| Short | R4: The time period in which this catalog entry is expected to be active (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: The time period in which this catalog entry is expected to be active (new)) (Extension Type: Period) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 30. Basic.extension:validTo | |||||
| Slice Name | validTo | ||||
| Definition | R4: | ||||
| Short | R4: The date until which this catalog entry is expected to be active (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: The date until which this catalog entry is expected to be active (new)) (Extension Type: dateTime) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 32. Basic.extension:lastUpdated | |||||
| Slice Name | lastUpdated | ||||
| Definition | R4: | ||||
| Short | R4: When was this catalog last updated (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: When was this catalog last updated (new)) (Extension Type: dateTime) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 34. Basic.extension:additionalCharacteristic | |||||
| Slice Name | additionalCharacteristic | ||||
| Definition | R4: | ||||
| Short | R4: Additional characteristics of the catalog entry (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Additional characteristics of the catalog entry (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 36. Basic.extension:additionalClassification | |||||
| Slice Name | additionalClassification | ||||
| Definition | R4: | ||||
| Short | R4: Additional classification of the catalog entry (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Additional classification of the catalog entry (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 38. Basic.extension:relatedEntry | |||||
| Slice Name | relatedEntry | ||||
| Definition | R4: | ||||
| Short | R4: An item that this catalog entry is related to (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: An item that this catalog entry is related to (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 40. Basic.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 42. Basic.identifier | |||||
| Definition | Identifier assigned to the resource for business purposes, outside the context of FHIR. | ||||
| Short | Business identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 44. Basic.code | |||||
| Definition | Identifies the 'type' of resource - equivalent to the resource name for other resources. | ||||
| Short | Kind of Resource | ||||
| Comments | Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because the it defines the meaning of the resource and cannot be ignored. | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see Basic Resource Types (example to http://hl7.org/fhir/ValueSet/basic-resource-type|3.0.2)Codes for identifying types of resources not yet defined by FHIR | ||||
| Type | CodeableConcept | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Requirements | Must be able to distinguish different types of Basic resources. | ||||
| 46. Basic.subject | |||||
| Definition | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. | ||||
| Short | Identifies the focus of this resource | ||||
| Comments | Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension. | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| Summary | true | ||||
| Requirements | Needed for partitioning the resource by Patient. | ||||
| 48. Basic.created | |||||
| Definition | Identifies when the resource was first created. | ||||
| Short | When created | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows ordering resource instances by time. | ||||
| 50. Basic.author | |||||
| Definition | Indicates who was responsible for creating the resource instance. | ||||
| Short | Who created | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner, Patient, RelatedPerson) | ||||
| Summary | true | ||||
| Requirements | Needed for partitioning the resource. | ||||
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r4.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change