Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-ActivityDefinition resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ActivityDefinition | |
| Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. |
| Short | The definition of a specific activity to be taken, independent of any particular patient or context |
| Control | 0..* |
| 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. ActivityDefinition.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. ActivityDefinition.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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. ActivityDefinition.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) |
| 8. ActivityDefinition.extension:subtitle | |
| Slice Name | subtitle |
| Definition | R5: |
| Short | R5: Subordinate title of the activity definition (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Subordinate title of the activity definition (new)) (Extension Type: string) |
| 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. ActivityDefinition.extension:subject | |
| Slice Name | subject |
| Definition | R5: |
| Short | R5: Type of individual the activity definition is intended for (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Type of individual the activity definition is intended for (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic)) |
| 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. ActivityDefinition.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) |
| 14. ActivityDefinition.extension:profile | |
| Slice Name | profile |
| Definition | R5: |
| Short | R5: What profile the resource needs to conform to (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: What profile the resource needs to conform to (new)) (Extension Type: uri(Cross-version Profile for R5.StructureDefinition for use in FHIR STU3, StructureDefinition)) |
| 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. ActivityDefinition.extension:intent | |
| Slice Name | intent |
| Definition | R5: |
| Short | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (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. ActivityDefinition.extension:priority | |
| Slice Name | priority |
| Definition | R5: |
| Short | R5: routine | urgent | asap | stat (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: routine | urgent | asap | stat (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()) |
| 20. ActivityDefinition.extension:timing | |
| Slice Name | timing |
| Definition | R5: |
| Short | R5: timing additional types |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: timing additional types) (Extension Type: Choice of: Age, Duration) |
| 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. ActivityDefinition.extension:asNeeded | |
| Slice Name | asNeeded |
| Definition | R5: |
| Short | R5: Preconditions for service (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, 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()) |
| 24. ActivityDefinition.extension:specimenRequirement | |
| Slice Name | specimenRequirement |
| Definition | R5: |
| Short | R5: What specimens are required to perform this action (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: What specimens are required to perform this action (new)) (Extension Type: uri(Cross-version Profile for R5.SpecimenDefinition for use in FHIR STU3, Basic)) |
| 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. ActivityDefinition.extension:observationRequirement | |
| Slice Name | observationRequirement |
| Definition | R5: |
| Short | R5: What observations are required to perform this action (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: What observations are required to perform this action (new)) (Extension Type: uri(Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic)) |
| 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. ActivityDefinition.extension:observationResultRequirement | |
| Slice Name | observationResultRequirement |
| Definition | R5: |
| Short | R5: What observations must be produced by this action (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: What observations must be produced by this action (new)) (Extension Type: uri(Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic)) |
| 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. ActivityDefinition.modifierExtension | |
| Definition | An Extension 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 | ExtensionExtensions 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 |
| Slicing | This element introduces a set of slices on ActivityDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. ActivityDefinition.modifierExtension:doNotPerform | |
| Slice Name | doNotPerform |
| Definition | R5: |
| Short | R5: True if the activity should not be performed (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: True if the activity should not be performed (new)) (Extension Type: boolean) |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| 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. ActivityDefinition.status | |
| Definition | The status of this activity definition. Enables tracking the life-cycle of the content. |
| Short | draft | active | retired | unknown |
| Comments | Allows filtering of activity definitions that are appropriate for use vs. not. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)The lifecycle status of a Value Set or Concept Map. |
| Type | code |
| 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 |
| 36. ActivityDefinition.experimental | |
| Definition | A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
| Short | For testing purposes, not real usage |
| Comments | Allows filtering of activity definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental activity definition in production. |
| Control | 0..1 |
| Type | boolean |
| 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 |
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition. |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ActivityDefinition | |
| 2. ActivityDefinition.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. ActivityDefinition.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) |
| 6. ActivityDefinition.extension:subtitle | |
| Slice Name | subtitle |
| Definition | R5: |
| Short | R5: Subordinate title of the activity definition (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Subordinate title of the activity definition (new)) (Extension Type: string) |
| 8. ActivityDefinition.extension:subject | |
| Slice Name | subject |
| Definition | R5: |
| Short | R5: Type of individual the activity definition is intended for (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Type of individual the activity definition is intended for (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic)) |
| 10. ActivityDefinition.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) |
| 12. ActivityDefinition.extension:profile | |
| Slice Name | profile |
| Definition | R5: |
| Short | R5: What profile the resource needs to conform to (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: What profile the resource needs to conform to (new)) (Extension Type: uri(Cross-version Profile for R5.StructureDefinition for use in FHIR STU3, StructureDefinition)) |
| 14. ActivityDefinition.extension:intent | |
| Slice Name | intent |
| Definition | R5: |
| Short | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new)) (Extension Type: code) |
| 16. ActivityDefinition.extension:priority | |
| Slice Name | priority |
| Definition | R5: |
| Short | R5: routine | urgent | asap | stat (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: routine | urgent | asap | stat (new)) (Extension Type: code) |
| 18. ActivityDefinition.extension:timing | |
| Slice Name | timing |
| Definition | R5: |
| Short | R5: timing additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: timing additional types) (Extension Type: Choice of: Age, Duration) |
| 20. ActivityDefinition.extension:asNeeded | |
| Slice Name | asNeeded |
| Definition | R5: |
| Short | R5: Preconditions for service (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, CodeableConcept) |
| 22. ActivityDefinition.extension:specimenRequirement | |
| Slice Name | specimenRequirement |
| Definition | R5: |
| Short | R5: What specimens are required to perform this action (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: What specimens are required to perform this action (new)) (Extension Type: uri(Cross-version Profile for R5.SpecimenDefinition for use in FHIR STU3, Basic)) |
| 24. ActivityDefinition.extension:observationRequirement | |
| Slice Name | observationRequirement |
| Definition | R5: |
| Short | R5: What observations are required to perform this action (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: What observations are required to perform this action (new)) (Extension Type: uri(Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic)) |
| 26. ActivityDefinition.extension:observationResultRequirement | |
| Slice Name | observationResultRequirement |
| Definition | R5: |
| Short | R5: What observations must be produced by this action (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: What observations must be produced by this action (new)) (Extension Type: uri(Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic)) |
| 28. ActivityDefinition.modifierExtension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. ActivityDefinition.modifierExtension:doNotPerform | |
| Slice Name | doNotPerform |
| Definition | R5: |
| Short | R5: True if the activity should not be performed (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: True if the activity should not be performed (new)) (Extension Type: boolean) |
| 32. ActivityDefinition.contributor | |
| 34. ActivityDefinition.contributor.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.contributor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. ActivityDefinition.contributor.extension:author | |
| Slice Name | author |
| Definition | R5: |
| Short | R5: Who authored the content additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who authored the content additional types) (Complex Extension) |
| 38. ActivityDefinition.contributor.extension:editor | |
| Slice Name | editor |
| Definition | R5: |
| Short | R5: Who edited the content additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who edited the content additional types) (Complex Extension) |
| 40. ActivityDefinition.contributor.extension:reviewer | |
| Slice Name | reviewer |
| Definition | R5: |
| Short | R5: Who reviewed the content additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who reviewed the content additional types) (Complex Extension) |
| 42. ActivityDefinition.contributor.extension:endorser | |
| Slice Name | endorser |
| Definition | R5: |
| Short | R5: Who endorsed the content additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who endorsed the content additional types) (Complex Extension) |
| 44. ActivityDefinition.contact | |
| 46. ActivityDefinition.contact.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. ActivityDefinition.contact.extension:contact | |
| Slice Name | contact |
| Definition | R5: |
| Short | R5: contact additional types |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..* |
| Type | Extension(R5: contact additional types) (Complex Extension) |
| 50. ActivityDefinition.library | |
| 52. ActivityDefinition.library.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. ActivityDefinition.library.extension:library | |
| Slice Name | library |
| Definition | R5: |
| Short | R5: Logic used by the activity definition additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Logic used by the activity definition additional types) (Extension Type: uri(Cross-version Profile for R5.Library for use in FHIR STU3, Library)) |
| 56. ActivityDefinition.location | |
| 58. ActivityDefinition.location.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 60. ActivityDefinition.location.extension:location | |
| Slice Name | location |
| Definition | R5: |
| Short | R5: location additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: location additional types) (Extension Type: CodeableConcept) |
| 62. ActivityDefinition.participant | |
| 64. ActivityDefinition.participant.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 66. ActivityDefinition.participant.extension:typeCanonical | |
| Slice Name | typeCanonical |
| Definition | R5: |
| Short | R5: Who or what can participate (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Who or what can participate (new)) (Extension Type: uri(Cross-version Profile for R5.CapabilityStatement for use in FHIR STU3, CapabilityStatement)) |
| 68. ActivityDefinition.participant.extension:typeReference | |
| Slice Name | typeReference |
| Definition | R5: |
| Short | R5: Who or what can participate (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Who or what can participate (new)) (Extension Type: Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3, CareTeam, Cross-version Profile for R5.Device for use in FHIR STU3, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.Endpoint for use in FHIR STU3, Endpoint, Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R5.Location for use in FHIR STU3, Location, Cross-version Profile for R5.Organization for use in FHIR STU3, Organization, Cross-version Profile for R5.Patient for use in FHIR STU3, Patient, Cross-version Profile for R5.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR STU3, RelatedPerson)) |
| 70. ActivityDefinition.participant.extension:function | |
| Slice Name | function |
| Definition | R5: |
| Short | R5: E.g. Author, Reviewer, Witness, etc (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: E.g. Author, Reviewer, Witness, etc (new)) (Extension Type: CodeableConcept) |
| 72. ActivityDefinition.participant.type | |
| 74. ActivityDefinition.participant.type.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.participant.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 76. ActivityDefinition.participant.type.extension:type | |
| Slice Name | type |
| Definition | R5: |
| Short | R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson) (Extension Type: code) |
| 78. ActivityDefinition.productReference | |
| 80. ActivityDefinition.productReference.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.productReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 82. ActivityDefinition.productReference.extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | R5: |
| Short | R5: product |
| Comments | Element |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 84. ActivityDefinition.transform | |
| 86. ActivityDefinition.transform.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ActivityDefinition.transform.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 88. ActivityDefinition.transform.extension:transform | |
| Slice Name | transform |
| Definition | R5: |
| Short | R5: transform additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: transform additional types) (Extension Type: uri(Cross-version Profile for R5.StructureMap for use in FHIR STU3, StructureMap)) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ActivityDefinition | |||||
| Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. | ||||
| Short | The definition of a specific activity to be taken, independent of any particular patient or context | ||||
| Control | 0..* | ||||
| 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. ActivityDefinition.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. ActivityDefinition.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. ActivityDefinition.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. ActivityDefinition.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. ActivityDefinition.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. ActivityDefinition.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. ActivityDefinition.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. ActivityDefinition.extension:versionAlgorithm | |||||
| Slice Name | versionAlgorithm | ||||
| Definition | R5: | ||||
| Short | R5: How to compare versions (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) | ||||
| 18. ActivityDefinition.extension:subtitle | |||||
| Slice Name | subtitle | ||||
| Definition | R5: | ||||
| Short | R5: Subordinate title of the activity definition (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Subordinate title of the activity definition (new)) (Extension Type: string) | ||||
| 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. ActivityDefinition.extension:subject | |||||
| Slice Name | subject | ||||
| Definition | R5: | ||||
| Short | R5: Type of individual the activity definition is intended for (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Type of individual the activity definition is intended for (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic)) | ||||
| 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. ActivityDefinition.extension:copyrightLabel | |||||
| Slice Name | copyrightLabel | ||||
| Definition | R5: | ||||
| Short | R5: Copyright holder and year(s) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) | ||||
| 24. ActivityDefinition.extension:profile | |||||
| Slice Name | profile | ||||
| Definition | R5: | ||||
| Short | R5: What profile the resource needs to conform to (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: What profile the resource needs to conform to (new)) (Extension Type: uri(Cross-version Profile for R5.StructureDefinition for use in FHIR STU3, StructureDefinition)) | ||||
| 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. ActivityDefinition.extension:intent | |||||
| Slice Name | intent | ||||
| Definition | R5: | ||||
| Short | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (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. ActivityDefinition.extension:priority | |||||
| Slice Name | priority | ||||
| Definition | R5: | ||||
| Short | R5: routine | urgent | asap | stat (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: routine | urgent | asap | stat (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()) | ||||
| 30. ActivityDefinition.extension:timing | |||||
| Slice Name | timing | ||||
| Definition | R5: | ||||
| Short | R5: timing additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: timing additional types) (Extension Type: Choice of: Age, Duration) | ||||
| 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. ActivityDefinition.extension:asNeeded | |||||
| Slice Name | asNeeded | ||||
| Definition | R5: | ||||
| Short | R5: Preconditions for service (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, 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()) | ||||
| 34. ActivityDefinition.extension:specimenRequirement | |||||
| Slice Name | specimenRequirement | ||||
| Definition | R5: | ||||
| Short | R5: What specimens are required to perform this action (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: What specimens are required to perform this action (new)) (Extension Type: uri(Cross-version Profile for R5.SpecimenDefinition for use in FHIR STU3, Basic)) | ||||
| 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. ActivityDefinition.extension:observationRequirement | |||||
| Slice Name | observationRequirement | ||||
| Definition | R5: | ||||
| Short | R5: What observations are required to perform this action (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: What observations are required to perform this action (new)) (Extension Type: uri(Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic)) | ||||
| 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. ActivityDefinition.extension:observationResultRequirement | |||||
| Slice Name | observationResultRequirement | ||||
| Definition | R5: | ||||
| Short | R5: What observations must be produced by this action (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: What observations must be produced by this action (new)) (Extension Type: uri(Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic)) | ||||
| 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. ActivityDefinition.modifierExtension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 42. ActivityDefinition.modifierExtension:doNotPerform | |||||
| Slice Name | doNotPerform | ||||
| Definition | R5: | ||||
| Short | R5: True if the activity should not be performed (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: True if the activity should not be performed (new)) (Extension Type: boolean) | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| 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()) | ||||
| 44. ActivityDefinition.url | |||||
| Definition | An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see Technical and Business Versions. | ||||
| Short | Logical URI to reference this activity definition (globally unique) | ||||
| Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the activity definition to be referenced by a single globally unique identifier. | ||||
| 46. ActivityDefinition.identifier | |||||
| Definition | A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||
| Short | Additional identifier for the activity definition | ||||
| Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this activity definition outside of FHIR, where it is not possible to use the logical URI. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||
| 48. ActivityDefinition.version | |||||
| Definition | The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. | ||||
| Short | Business version of the activity definition | ||||
| Comments | There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the activity definition with the format [url]|[version]. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 50. ActivityDefinition.name | |||||
| Definition | A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||
| Short | Name for this activity definition (computer friendly) | ||||
| Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Support human navigation and code generation. | ||||
| 52. ActivityDefinition.title | |||||
| Definition | A short, descriptive, user-friendly title for the activity definition. | ||||
| Short | Name for this activity definition (human friendly) | ||||
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 54. ActivityDefinition.status | |||||
| Definition | The status of this activity definition. Enables tracking the life-cycle of the content. | ||||
| Short | draft | active | retired | unknown | ||||
| Comments | Allows filtering of activity definitions that are appropriate for use vs. not. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)The lifecycle status of a Value Set or Concept Map. | ||||
| Type | code | ||||
| 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 | ||||
| 56. ActivityDefinition.experimental | |||||
| Definition | A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. | ||||
| Short | For testing purposes, not real usage | ||||
| Comments | Allows filtering of activity definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental activity definition in production. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| 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 | ||||
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition. | ||||
| 58. ActivityDefinition.date | |||||
| Definition | The date (and optionally time) when the activity definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes. | ||||
| Short | Date this was last changed | ||||
| Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Revision Date | ||||
| 60. ActivityDefinition.publisher | |||||
| Definition | The name of the individual or organization that published the activity definition. | ||||
| Short | Name of the publisher (organization or individual) | ||||
| Comments | Usually an organization, but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Helps establish the "authority/credibility" of the activity definition. May also allow for contact. | ||||
| 62. ActivityDefinition.description | |||||
| Definition | A free text natural language description of the activity definition from a consumer's perspective. | ||||
| Short | Natural language description of the activity definition | ||||
| Comments | This description can be used to capture details such as why the activity definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 64. ActivityDefinition.purpose | |||||
| Definition | Explaination of why this activity definition is needed and why it has been designed as it has. | ||||
| Short | Why this activity definition is defined | ||||
| Comments | This element does not describe the usage of the activity definition Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition. | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 66. ActivityDefinition.usage | |||||
| Definition | A detailed description of how the asset is used from a clinical perspective. | ||||
| Short | Describes the clinical usage of the asset | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 68. ActivityDefinition.approvalDate | |||||
| Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||
| Short | When the activity definition was approved by publisher | ||||
| Comments | The 'date' element may be more recent than the approval date because of minor changes / editorial corrections. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 70. ActivityDefinition.lastReviewDate | |||||
| Definition | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. | ||||
| Short | When the activity definition was last reviewed | ||||
| Comments | If specified, this is usually after the approval date. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||
| 72. ActivityDefinition.effectivePeriod | |||||
| Definition | The period during which the activity definition content was or is planned to be in active use. | ||||
| Short | When the activity definition is expected to be used | ||||
| Comments | The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the activity definition are or are expected to be used instead. | ||||
| 74. ActivityDefinition.useContext | |||||
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate activity definition instances. | ||||
| Short | Context the content is intended to support | ||||
| Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. | ||||
| Control | 0..* | ||||
| Type | UsageContext | ||||
| Summary | true | ||||
| Requirements | Assist in searching for appropriate content. | ||||
| 76. ActivityDefinition.jurisdiction | |||||
| Definition | A legal or geographic region in which the activity definition is intended to be used. | ||||
| Short | Intended jurisdiction for activity definition (if applicable) | ||||
| Comments | It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2)Countries and regions within which this artifact is targeted for use | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 78. ActivityDefinition.topic | |||||
| Definition | Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. | ||||
| Short | E.g. Education, Treatment, Assessment, etc | ||||
| Control | 0..* | ||||
| Binding | For example codes, see DefinitionTopic (example to http://hl7.org/fhir/ValueSet/definition-topic|3.0.2)High-level categorization of the definition, used for searching, sorting, and filtering | ||||
| Type | CodeableConcept | ||||
| Requirements | Repositories must be able to determine how to categorize the asset so that it can be found by topical searches. | ||||
| 80. ActivityDefinition.contributor | |||||
| Definition | A contributor to the content of the asset, including authors, editors, reviewers, and endorsers. | ||||
| Short | A content contributor | ||||
| Control | 0..* | ||||
| Type | Contributor | ||||
| Requirements | Consumers of the content must be able to quickly determine who contributed to the content of the knowledge asset. | ||||
| 82. ActivityDefinition.contributor.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. | ||||
| 84. ActivityDefinition.contributor.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.contributor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 86. ActivityDefinition.contributor.extension:author | |||||
| Slice Name | author | ||||
| Definition | R5: | ||||
| Short | R5: Who authored the content additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Who authored the content additional types) (Complex Extension) | ||||
| 88. ActivityDefinition.contributor.extension:editor | |||||
| Slice Name | editor | ||||
| Definition | R5: | ||||
| Short | R5: Who edited the content additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Who edited the content additional types) (Complex Extension) | ||||
| 90. ActivityDefinition.contributor.extension:reviewer | |||||
| Slice Name | reviewer | ||||
| Definition | R5: | ||||
| Short | R5: Who reviewed the content additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Who reviewed the content additional types) (Complex Extension) | ||||
| 92. ActivityDefinition.contributor.extension:endorser | |||||
| Slice Name | endorser | ||||
| Definition | R5: | ||||
| Short | R5: Who endorsed the content additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Who endorsed the content additional types) (Complex Extension) | ||||
| 94. ActivityDefinition.contributor.type | |||||
| Definition | The type of contributor. | ||||
| Short | author | editor | reviewer | endorser | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ContributorType (required to http://hl7.org/fhir/ValueSet/contributor-type|3.0.2)The type of contributor | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 96. ActivityDefinition.contributor.name | |||||
| Definition | The name of the individual or organization responsible for the contribution. | ||||
| Short | Who contributed the content | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 98. ActivityDefinition.contributor.contact | |||||
| Definition | Contact details to assist a user in finding and communicating with the contributor. | ||||
| Short | Contact details of the contributor | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Summary | true | ||||
| 100. ActivityDefinition.contact | |||||
| Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||
| Short | Contact details for the publisher | ||||
| Comments | May be a web site, an email address, a telephone number, etc. | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Summary | true | ||||
| 102. ActivityDefinition.contact.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. | ||||
| 104. ActivityDefinition.contact.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 106. ActivityDefinition.contact.extension:contact | |||||
| Slice Name | contact | ||||
| Definition | R5: | ||||
| Short | R5: contact additional types | ||||
| Comments | Element See guidance around (not) making local changes to elements here. | ||||
| Control | 0..* | ||||
| Type | Extension(R5: contact additional types) (Complex Extension) | ||||
| 108. ActivityDefinition.contact.name | |||||
| Definition | The name of an individual to contact. | ||||
| Short | Name of an individual to contact | ||||
| Comments | If there is no named individual, the telecom information is for the organization as a whole. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 110. ActivityDefinition.contact.telecom | |||||
| Definition | The contact details for the individual (if a name was provided) or the organization. | ||||
| Short | Contact details for individual or organization | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Summary | true | ||||
| 112. ActivityDefinition.copyright | |||||
| Definition | A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. | ||||
| Short | Use and/or publishing restrictions | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content. | ||||
| Alternate Names | License, Restrictions | ||||
| 114. ActivityDefinition.relatedArtifact | |||||
| Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||
| Short | Additional documentation, citations, etc | ||||
| Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||
| Control | 0..* | ||||
| Type | RelatedArtifact | ||||
| Requirements | Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. | ||||
| 116. ActivityDefinition.library | |||||
| Definition | A reference to a Library resource containing any formal logic used by the asset. | ||||
| Short | Logic used by the asset | ||||
| Control | 0..* | ||||
| Type | Reference(Library) | ||||
| 118. ActivityDefinition.library.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. | ||||
| 120. ActivityDefinition.library.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 122. ActivityDefinition.library.extension:library | |||||
| Slice Name | library | ||||
| Definition | R5: | ||||
| Short | R5: Logic used by the activity definition additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Logic used by the activity definition additional types) (Extension Type: uri(Cross-version Profile for R5.Library for use in FHIR STU3, Library)) | ||||
| 124. ActivityDefinition.library.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 126. ActivityDefinition.library.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 128. ActivityDefinition.library.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 130. ActivityDefinition.kind | |||||
| Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource. | ||||
| Short | Kind of resource | ||||
| Comments | May determine what types of extensions are permitted. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ResourceType ![]() (required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)The kind of activity the definition is describing | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 132. ActivityDefinition.code | |||||
| Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | ||||
| Short | Detail type of activity | ||||
| Comments | Tends to be less relevant for activities involving particular products. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Procedure Codes (SNOMED CT) (example to http://hl7.org/fhir/ValueSet/procedure-code|3.0.2)Detailed type of the activity; e.g. CBC | ||||
| Type | CodeableConcept | ||||
| Requirements | Allows matching performed to planned as well as validation against protocols. | ||||
| 134. ActivityDefinition.timing[x] | |||||
| Definition | The period, timing or frequency upon which the described activity is to occur. | ||||
| Short | When activity is to occur | ||||
| Control | 0..1 | ||||
| Type | Choice of: Timing, dateTime, Period, Range | ||||
| [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 | ||||
| Requirements | Allows prompting for activities and detection of missed planned activities. | ||||
| 136. ActivityDefinition.location | |||||
| Definition | Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. | ||||
| Short | Where it should happen | ||||
| Comments | May reference a specific clinical location or may just identify a type of location. | ||||
| Control | 0..1 | ||||
| Type | Reference(Location) | ||||
| Requirements | Helps in planning of activity. | ||||
| Alternate Names | facility | ||||
| 138. ActivityDefinition.location.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. | ||||
| 140. ActivityDefinition.location.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 142. ActivityDefinition.location.extension:location | |||||
| Slice Name | location | ||||
| Definition | R5: | ||||
| Short | R5: location additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: location additional types) (Extension Type: CodeableConcept) | ||||
| 144. ActivityDefinition.location.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 146. ActivityDefinition.location.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 148. ActivityDefinition.location.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 150. ActivityDefinition.participant | |||||
| Definition | Indicates who should participate in performing the action described. | ||||
| Short | Who should participate in the action | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 152. ActivityDefinition.participant.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. | ||||
| 154. ActivityDefinition.participant.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 156. ActivityDefinition.participant.extension:typeCanonical | |||||
| Slice Name | typeCanonical | ||||
| Definition | R5: | ||||
| Short | R5: Who or what can participate (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Who or what can participate (new)) (Extension Type: uri(Cross-version Profile for R5.CapabilityStatement for use in FHIR STU3, CapabilityStatement)) | ||||
| 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()) | ||||
| 158. ActivityDefinition.participant.extension:typeReference | |||||
| Slice Name | typeReference | ||||
| Definition | R5: | ||||
| Short | R5: Who or what can participate (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Who or what can participate (new)) (Extension Type: Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3, CareTeam, Cross-version Profile for R5.Device for use in FHIR STU3, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.Endpoint for use in FHIR STU3, Endpoint, Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R5.Location for use in FHIR STU3, Location, Cross-version Profile for R5.Organization for use in FHIR STU3, Organization, Cross-version Profile for R5.Patient for use in FHIR STU3, Patient, Cross-version Profile for R5.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR STU3, RelatedPerson)) | ||||
| 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()) | ||||
| 160. ActivityDefinition.participant.extension:function | |||||
| Slice Name | function | ||||
| Definition | R5: | ||||
| Short | R5: E.g. Author, Reviewer, Witness, etc (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: E.g. Author, Reviewer, Witness, etc (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()) | ||||
| 162. ActivityDefinition.participant.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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 | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 164. ActivityDefinition.participant.type | |||||
| Definition | The type of participant in the action. | ||||
| Short | patient | practitioner | related-person | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ActionParticipantType ![]() (required to http://hl7.org/fhir/ValueSet/action-participant-type|3.0.2)The type of participant in the activity | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 166. ActivityDefinition.participant.type.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| 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. | ||||
| 168. ActivityDefinition.participant.type.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.participant.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 170. ActivityDefinition.participant.type.extension:type | |||||
| Slice Name | type | ||||
| Definition | R5: | ||||
| Short | R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson) (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()) | ||||
| 172. ActivityDefinition.participant.type.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 174. ActivityDefinition.participant.role | |||||
| Definition | The role the participant should play in performing the described action. | ||||
| Short | E.g. Nurse, Surgeon, Parent, etc | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see ActionParticipantRole (example to http://hl7.org/fhir/ValueSet/action-participant-role|3.0.2)Defines roles played by participants for the action | ||||
| Type | CodeableConcept | ||||
| 176. ActivityDefinition.product[x] | |||||
| Definition | Identifies the food, drug or other product being consumed or supplied in the activity. | ||||
| Short | What's administered/supplied | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see SNOMED CT Medication Codes (example to http://hl7.org/fhir/ValueSet/medication-codes|3.0.2)Code describing the type of substance or medication | ||||
| Type | Choice of: Reference(Medication, Substance), CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| 178. ActivityDefinition.product[x].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. | ||||
| 180. ActivityDefinition.product[x].extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.product[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 182. ActivityDefinition.product[x].extension:alternateReference | |||||
| Slice Name | alternateReference | ||||
| Definition | R5: | ||||
| Short | R5: product | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 184. ActivityDefinition.quantity | |||||
| Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). | ||||
| Short | How much is administered/consumed/supplied | ||||
| Control | 0..1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Alternate Names | dose | ||||
| 186. ActivityDefinition.dosage | |||||
| Definition | Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. | ||||
| Short | Detailed dosage instructions | ||||
| Comments | If a dosage instruction is used, the definition should not specify timing or quantity. | ||||
| Control | 0..* | ||||
| Type | Dosage | ||||
| 188. ActivityDefinition.bodySite | |||||
| Definition | Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). | ||||
| Short | What part of body to perform on | ||||
| Comments | Only used if not implicit in the code found in ProcedureRequest.type. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see SNOMED CT Body Structures (example to http://hl7.org/fhir/ValueSet/body-site|3.0.2)A code that identifies the anatomical location | ||||
| Type | CodeableConcept | ||||
| Requirements | Knowing where the procedure is made is important for tracking if multiple sites are possible. | ||||
| 190. ActivityDefinition.transform | |||||
| Definition | A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. | ||||
| Short | Transform to apply the template | ||||
| Control | 0..1 | ||||
| Type | Reference(StructureMap) | ||||
| 192. ActivityDefinition.transform.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. | ||||
| 194. ActivityDefinition.transform.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.transform.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 196. ActivityDefinition.transform.extension:transform | |||||
| Slice Name | transform | ||||
| Definition | R5: | ||||
| Short | R5: transform additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: transform additional types) (Extension Type: uri(Cross-version Profile for R5.StructureMap for use in FHIR STU3, StructureMap)) | ||||
| 198. ActivityDefinition.transform.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 200. ActivityDefinition.transform.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 202. ActivityDefinition.transform.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 204. ActivityDefinition.dynamicValue | |||||
| Definition | Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the intent resource that would contain the result. | ||||
| Short | Dynamic aspects of the definition | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 206. ActivityDefinition.dynamicValue.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. | ||||
| 208. ActivityDefinition.dynamicValue.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 | ||||
| 210. ActivityDefinition.dynamicValue.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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 | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 212. ActivityDefinition.dynamicValue.description | |||||
| Definition | A brief, natural language description of the intended semantics of the dynamic value. | ||||
| Short | Natural language description of the dynamic value | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 214. ActivityDefinition.dynamicValue.path | |||||
| Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. | ||||
| Short | The path to the element to be set dynamically | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 216. ActivityDefinition.dynamicValue.language | |||||
| Definition | The media type of the language for the expression. | ||||
| Short | Language of the expression | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 218. ActivityDefinition.dynamicValue.expression | |||||
| Definition | An expression specifying the value of the customized element. | ||||
| Short | An expression that provides the dynamic value for the customization | ||||
| Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||