Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the ext-R4B-PlanDefinition.relatedArtifact extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: Optional Extension Element - found in all resources. |
| Short | R4B: Additional documentation, citations additional typesOptional Extensions Element |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 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())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()) |
| 2. Extension.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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:_datatype | |
| Slice Name | _datatype |
| Definition | Slice to indicate the presence of a R4B |
| Short | DataType slice for a FHIR R4B `RelatedArtifact` valueAdditional Content defined by implementations |
| Control | 10..1* |
| Type | Extension |
| 6. Extension.extension:_datatype.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 |
| 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. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/_datatype |
| 8. Extension.extension:_datatype.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Comments | Must be: RelatedArtifact |
| Control | 10..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | RelatedArtifact |
| 10. Extension.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: typeAdditional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 12. 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 |
| 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. |
| Fixed Value | type |
| 14. Extension.extension:type.value[x] | |
| Definition | The type of relationship to the related artifact. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-ofValue of extension |
| Control | 10..1 |
| Binding | The codes SHALL be taken from For codes, see RelatedArtifactType (required to http://hl7.org/fhir/ValueSet/related-artifact-type|3.0.2) |
| Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Extension.extension:label | |
| Slice Name | label |
| Definition | R4B: |
| Short | R4B: Short label (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:label.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 |
| 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. |
| Fixed Value | label |
| 20. Extension.extension:label.value[x] | |
| Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Short labelValue of extension |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Extension.extension:display | |
| Slice Name | display |
| Definition | R4B: |
| Short | R4B: displayAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 24. Extension.extension:display.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 |
| 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. |
| Fixed Value | display |
| 26. Extension.extension:display.value[x] | |
| Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Brief description of the related artifactValue of extension |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. Extension.extension:citation | |
| Slice Name | citation |
| Definition | R4B: |
| Short | R4B: citationAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 30. Extension.extension:citation.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 |
| 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. |
| Fixed Value | citation |
| 32. Extension.extension:citation.value[x] | |
| Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Bibliographic citation for the artifactValue of extension |
| Comments | Additional structured information about citations should be captured as extensions. |
| Control | 0..1 |
| Type | markdown, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. Extension.extension:url | |
| Slice Name | url |
| Definition | R4B: |
| Short | R4B: urlAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 36. Extension.extension:url.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 |
| 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. |
| Fixed Value | url |
| 38. Extension.extension:url.value[x] | |
| Definition | A url for the artifact that can be followed to access the actual content. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Where the artifact can be accessedValue of extension |
| Comments | If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference). |
| Control | 0..1 |
| Type | uri, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. Extension.extension:document | |
| Slice Name | document |
| Definition | R4B: |
| Short | R4B: document additional typesAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 42. Extension.extension:document.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 |
| 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. |
| Fixed Value | document |
| 44. Extension.extension:document.value[x] | |
| Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | What document is being referencedValue of extension |
| Control | 0..1 |
| Type | Attachment, date, dateTime, Meta, code, string, Address, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 46. Extension.extension:resource | |
| Slice Name | resource |
| Definition | R4B: |
| Short | R4B: resource additional typesAdditional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 48. Extension.extension:resource.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 |
| 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. |
| Fixed Value | resource |
| 50. Extension.extension:resource.value[x] | |
| Definition | The related resource, such as a library, value set, profile, or other knowledge resource. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | What resource is being referencedValue of extension |
| Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource. |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 52. 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 |
| 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. |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-PlanDefinition.relatedArtifact |
| 54. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: |
| Short | R4B: Additional documentation, citations additional types |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| 2. Extension.extension | |
| Control | 0..* |
| 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:_datatype | |
| Slice Name | _datatype |
| Definition | Slice to indicate the presence of a R4B |
| Short | DataType slice for a FHIR R4B `RelatedArtifact` value |
| Control | 1..1 |
| 6. Extension.extension:_datatype.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/_datatype |
| 8. Extension.extension:_datatype.value[x] | |
| Comments | Must be: RelatedArtifact |
| Control | 1..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | RelatedArtifact |
| 10. Extension.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: type |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 12. Extension.extension:type.url | |
| Control | 1..1 |
| Fixed Value | type |
| 14. Extension.extension:type.value[x] | |
| Definition | The type of relationship to the related artifact. |
| Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RelatedArtifactType (required to http://hl7.org/fhir/ValueSet/related-artifact-type|3.0.2) |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Extension.extension:label | |
| Slice Name | label |
| Definition | R4B: |
| Short | R4B: Short label (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 18. Extension.extension:label.url | |
| Control | 1..1 |
| Fixed Value | label |
| 20. Extension.extension:label.value[x] | |
| Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. |
| Short | Short label |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Extension.extension:display | |
| Slice Name | display |
| Definition | R4B: |
| Short | R4B: display |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 24. Extension.extension:display.url | |
| Control | 1..1 |
| Fixed Value | display |
| 26. Extension.extension:display.value[x] | |
| Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. |
| Short | Brief description of the related artifact |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. Extension.extension:citation | |
| Slice Name | citation |
| Definition | R4B: |
| Short | R4B: citation |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 30. Extension.extension:citation.url | |
| Control | 1..1 |
| Fixed Value | citation |
| 32. Extension.extension:citation.value[x] | |
| Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. |
| Short | Bibliographic citation for the artifact |
| Comments | Additional structured information about citations should be captured as extensions. |
| Control | 0..1 |
| Type | markdown |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. Extension.extension:url | |
| Slice Name | url |
| Definition | R4B: |
| Short | R4B: url |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 36. Extension.extension:url.url | |
| Control | 1..1 |
| Fixed Value | url |
| 38. Extension.extension:url.value[x] | |
| Definition | A url for the artifact that can be followed to access the actual content. |
| Short | Where the artifact can be accessed |
| Comments | If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference). |
| Control | 0..1 |
| Type | uri |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. Extension.extension:document | |
| Slice Name | document |
| Definition | R4B: |
| Short | R4B: document additional types |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 42. Extension.extension:document.url | |
| Control | 1..1 |
| Fixed Value | document |
| 44. Extension.extension:document.value[x] | |
| Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element. |
| Short | What document is being referenced |
| Control | 0..1 |
| Type | Attachment |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 46. Extension.extension:resource | |
| Slice Name | resource |
| Definition | R4B: |
| Short | R4B: resource additional types |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 48. Extension.extension:resource.url | |
| Control | 1..1 |
| Fixed Value | resource |
| 50. Extension.extension:resource.value[x] | |
| Definition | The related resource, such as a library, value set, profile, or other knowledge resource. |
| Short | What resource is being referenced |
| Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource. |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 52. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-PlanDefinition.relatedArtifact |
| 54. Extension.value[x] | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R4B: |
| Short | R4B: Additional documentation, citations additional types |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 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()) |
| 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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| 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:_datatype | |
| Slice Name | _datatype |
| Definition | Slice to indicate the presence of a R4B |
| Short | DataType slice for a FHIR R4B `RelatedArtifact` value |
| Control | 1..1 |
| Type | Extension |
| 8. Extension.extension:_datatype.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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 10. Extension.extension:_datatype.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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:_datatype.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 |
| 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. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/_datatype |
| 14. Extension.extension:_datatype.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Comments | Must be: RelatedArtifact |
| Control | 1..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Fixed Value | RelatedArtifact |
| 16. Extension.extension:type | |
| Slice Name | type |
| Definition | R4B: |
| Short | R4B: type |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 20. Extension.extension:type.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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 |
| 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. |
| Fixed Value | type |
| 24. Extension.extension:type.value[x] | |
| Definition | The type of relationship to the related artifact. |
| Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RelatedArtifactType (required to http://hl7.org/fhir/ValueSet/related-artifact-type|3.0.2) |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. Extension.extension:label | |
| Slice Name | label |
| Definition | R4B: |
| Short | R4B: Short label (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 28. Extension.extension:label.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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 30. Extension.extension:label.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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:label.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 |
| 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. |
| Fixed Value | label |
| 34. Extension.extension:label.value[x] | |
| Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. |
| Short | Short label |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. Extension.extension:display | |
| Slice Name | display |
| Definition | R4B: |
| Short | R4B: display |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 38. Extension.extension:display.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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 40. Extension.extension:display.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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:display.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 |
| 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. |
| Fixed Value | display |
| 44. Extension.extension:display.value[x] | |
| Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. |
| Short | Brief description of the related artifact |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 46. Extension.extension:citation | |
| Slice Name | citation |
| Definition | R4B: |
| Short | R4B: citation |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 48. Extension.extension:citation.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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 50. Extension.extension:citation.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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:citation.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 |
| 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. |
| Fixed Value | citation |
| 54. Extension.extension:citation.value[x] | |
| Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. |
| Short | Bibliographic citation for the artifact |
| Comments | Additional structured information about citations should be captured as extensions. |
| Control | 0..1 |
| Type | markdown |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. Extension.extension:url | |
| Slice Name | url |
| Definition | R4B: |
| Short | R4B: url |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 58. Extension.extension:url.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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 60. Extension.extension:url.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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:url.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 |
| 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. |
| Fixed Value | url |
| 64. Extension.extension:url.value[x] | |
| Definition | A url for the artifact that can be followed to access the actual content. |
| Short | Where the artifact can be accessed |
| Comments | If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference). |
| Control | 0..1 |
| Type | uri |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 66. Extension.extension:document | |
| Slice Name | document |
| Definition | R4B: |
| Short | R4B: document additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 68. Extension.extension:document.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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 70. Extension.extension:document.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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:document.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 |
| 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. |
| Fixed Value | document |
| 74. Extension.extension:document.value[x] | |
| Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element. |
| Short | What document is being referenced |
| Control | 0..1 |
| Type | Attachment |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 76. Extension.extension:resource | |
| Slice Name | resource |
| Definition | R4B: |
| Short | R4B: resource additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 78. Extension.extension:resource.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 | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| 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. |
| 80. Extension.extension:resource.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 | 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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:resource.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 |
| 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. |
| Fixed Value | resource |
| 84. Extension.extension:resource.value[x] | |
| Definition | The related resource, such as a library, value set, profile, or other knowledge resource. |
| Short | What resource is being referenced |
| Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource. |
| Control | 0..1 |
| Type | uri(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 86. 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 |
| 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. |
| Fixed Value | http://hl7.org/fhir/4.3/StructureDefinition/extension-PlanDefinition.relatedArtifact |
| 88. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |