IGTTPFHIRGatewaygICS - Local Development build (v2025.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2025-06-12 |
Definitions for the ConsentPolicy resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ActivityDefinition | |
| Definition | Atomare Aussage zu der eine Person seine Einwilligung erteilen kann This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. |
| Short | Consent PolicyThe 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-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 or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}')) |
| 2. ActivityDefinition.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | Meta |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. ActivityDefinition.meta.lastUpdated | |
| Definition | When the resource last changed - e.g. when the version changed. |
| Short | updateDateWhen the resource version last changed |
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | instant |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. ActivityDefinition.extension:created | |
| Slice Name | created |
| Definition | Erstellungsdatum der Ressource/Information |
| Short | Created |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Created) (Extension Type: instant) |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. ActivityDefinition.extension:externalProperty | |
| Slice Name | externalProperty |
| Definition | Liste frei konfigurierbarer external Properties nach dem KeyValuePrinzip zur Auswertung durch externe Anwendersysteme |
| Short | externalProperties |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(External Property Element) (Complex Extension) |
| Must Support | true |
| Label | externalProperties |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. ActivityDefinition.extension:externalProperty.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 20..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ActivityDefinition.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. ActivityDefinition.extension:externalProperty.extension:key | |
| Slice Name | key |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 10..1* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Label | Key |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 16. ActivityDefinition.extension:externalProperty.extension:key.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ActivityDefinition.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. ActivityDefinition.extension:externalProperty.extension:key.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | key |
| 20. ActivityDefinition.extension:externalProperty.extension:key.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. ActivityDefinition.extension:externalProperty.extension:value | |
| Slice Name | value |
| Definition | An Extension |
| Short | ExtensionAdditional content defined by implementations |
| Control | 10..1* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Label | Value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 24. ActivityDefinition.extension:externalProperty.extension:value.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ActivityDefinition.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. ActivityDefinition.extension:externalProperty.extension:value.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | value |
| 28. ActivityDefinition.extension:externalProperty.extension:value.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. ActivityDefinition.extension:externalProperty.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty |
| 32. ActivityDefinition.extension:externalProperty.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. ActivityDefinition.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| 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..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Standard Status | Normative (from Trial Use) |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ActivityDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. |
| Short | Canonical identifier for this activity definition, represented as a URI (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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
| Control | 0..01 This element is affected by the following invariants: ele-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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. 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, and can then 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..0* This element is affected by the following invariants: ele-1 |
| Type | Identifier |
| Summary | true |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. 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 | versionBusiness 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 reference 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 | 10..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Label | version |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. ActivityDefinition.name | |
| Definition | Name der ConsentPolicy (computer friendly) 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 | nameName for this activity definition (computer friendly) |
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
| Control | 10..1 This element is affected by the following invariants: ele-1, inv-0 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Support human navigation and code generation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. ActivityDefinition.title | |
| Definition | Bezeichnung (human friendly) A short, descriptive, user-friendly title for the activity definition. |
| Short | labelName 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 This element is affected by the following invariants: ele-1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. ActivityDefinition.subtitle | |
| Definition | An explanatory or alternate title for the activity definition giving additional information about its content. |
| Short | Subordinate title of the activity definition |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. ActivityDefinition.status | |
| Definition | Bearbeitungsstatus: gICS-Äquivalente: finalized=true => active finalized=false => draft The status of this activity definition. Enables tracking the life-cycle of the content. |
| Short | finalisiert ja/neindraft | active | retired | unknown |
| Comments | Allows filtering of activity definitions that are appropriate for use versus not. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)The lifecycle status of an artifact. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. 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 definitions that are appropriate for use versus not. |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | boolean |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. ActivityDefinition.subject[x] | |
| Definition | A code or group definition that describes the intended subject of the activity being defined. |
| Short | Type of individual the activity definition is intended for |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). |
| Type | Choice of: CodeableConcept, Reference(Group) |
| Meaning if Missing | Patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. ActivityDefinition.date | |
| Definition | The date (and optionally time) when the activity definition was published. The date must change 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 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..01 This element is affected by the following invariants: ele-1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | Revision Date |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. ActivityDefinition.publisher | |
| Definition | The name of the organization or individual 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..01 This element is affected by the following invariants: ele-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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. 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..0* This element is affected by the following invariants: ele-1 |
| Type | ContactDetail |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. ActivityDefinition.description | |
| Definition | administrative comment A free text natural language description of the activity definition from a consumer's perspective. |
| Short | commentNatural 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 activity definition is presumed to be the predominant language in the place the activity definition was created). |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. ActivityDefinition.useContext | |
| Definition | Verweis auf die Domäne The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances. |
| Short | domainNameThe context that the content is intended to support |
| Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
| Control | 10..1* This element is affected by the following invariants: ele-1 |
| Type | UsageContext |
| Must Support | true |
| Summary | true |
| Requirements | Assist in searching for appropriate content. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. ActivityDefinition.useContext.code | |
| Definition | A code that identifies the type of context being specified by this usage context. |
| Short | Type of context being specified |
| Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from UsageContextTypehttp://hl7.org/fhir/ValueSet/usage-context-type|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|4.0.1)A code that specifies a type of context being specified by a usage context. |
| Type | Coding |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. ActivityDefinition.useContext.code.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. ActivityDefinition.useContext.code.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Short | Symbol in syntax defined by the system |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Fixed Value | program |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. ActivityDefinition.useContext.value[x] | |
| Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
| Short | Value that defines the context |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Consent Domain, PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. ActivityDefinition.useContext.value[x].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 | 10..1 This element is affected by the following invariants: ele-1, ref-1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. 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..0* This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1)Countries and regions within which this artifact is targeted for use. |
| Type | CodeableConcept |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. ActivityDefinition.purpose | |
| Definition | Explanation 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..01 This element is affected by the following invariants: ele-1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. ActivityDefinition.usage | |
| Definition | administrative comment A detailed description of how the activity definition is used from a clinical perspective. |
| Short | commentDescribes the clinical usage of the activity definition |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. 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 |
| Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ |
| Control | 0..01 This element is affected by the following invariants: ele-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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. 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 or editorial corrections. |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. ActivityDefinition.lastReviewDate | |
| Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
| Short | When the activity definition was last reviewed |
| Comments | If specified, this date follows the original approval date. |
| Control | 0..01 This element is affected by the following invariants: ele-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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. 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..01 This element is affected by the following invariants: ele-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 the activity definition are or are expected to be used instead. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end)) |
| 88. 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. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic|4.0.1 (example to http://hl7.org/fhir/ValueSet/definition-topic|4.0.1)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 activity definition so that it can be found by topical searches. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. ActivityDefinition.author | |
| Definition | An individiual or organization primarily involved in the creation and maintenance of the content. |
| Short | Who authored the content |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | ContactDetail |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 92. ActivityDefinition.editor | |
| Definition | An individual or organization primarily responsible for internal coherence of the content. |
| Short | Who edited the content |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | ContactDetail |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. ActivityDefinition.reviewer | |
| Definition | An individual or organization primarily responsible for review of some aspect of the content. |
| Short | Who reviewed the content |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | ContactDetail |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 96. ActivityDefinition.endorser | |
| Definition | An individual or organization responsible for officially endorsing the content for use in some setting. |
| Short | Who endorsed the content |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | ContactDetail |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 98. 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..0* This element is affected by the following invariants: ele-1 |
| Type | RelatedArtifact |
| Requirements | Activity definitions 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 100. ActivityDefinition.library | |
| Definition | A reference to a Library resource containing any formal logic used by the activity definition. |
| Short | Logic used by the activity definition |
| Comments | |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | canonical(Library) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 102. ActivityDefinition.kind | |
| Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, 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..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from RequestResourceTypehttp://hl7.org/fhir/ValueSet/request-resource-types|4.0.1 (required to http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1)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 |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 104. ActivityDefinition.profile | |
| Definition | A profile to which the target of the activity definition is expected to conform. |
| Short | What profile the resource needs to conform to |
| Comments | |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | canonical(StructureDefinition) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 106. 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 | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Policyhttp://hl7.org/fhir/ValueSet/procedure-code|4.0.1 (extensible to https://ths-greifswald.de/fhir/ValueSet/gics/Policy) |
| Type | CodeableConcept |
| Must Support | true |
| Summary | true |
| Requirements | Allows matching performed to planned as well as validation against protocols. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 108. ActivityDefinition.code.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Type | Coding |
| Must Support | true |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 110. ActivityDefinition.code.coding.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 112. ActivityDefinition.code.coding.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Short | Symbol in syntax defined by the system |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 114. ActivityDefinition.intent | |
| Definition | Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. |
| Short | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 (required to http://hl7.org/fhir/ValueSet/request-intent|4.0.1)Codes indicating the degree of authority/intentionality associated with a request. |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 116. ActivityDefinition.priority | |
| Definition | Indicates how quickly the activity should be addressed with respect to other requests. |
| Short | routine | urgent | asap | stat |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)Identifies the level of importance to be assigned to actioning the request. |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 118. ActivityDefinition.doNotPerform | |
| Definition | Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. |
| Short | True if the activity should not be performed |
| Comments | This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestGroup. |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | boolean |
| Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 120. 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..01 This element is affected by the following invariants: ele-1 |
| Type | Choice of: Timing, dateTime, Age, Period, Range, Duration |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 122. 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..01 This element is affected by the following invariants: ele-1 |
| Type | Reference(Location) |
| Requirements | Helps in planning of activity. |
| Alternate Names | facility |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 124. ActivityDefinition.participant | |
| Definition | Indicates who should participate in performing the action described. |
| Short | Who should participate in the action |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 128. 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..01 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes|4.0.1 (example to http://hl7.org/fhir/ValueSet/medication-codes|4.0.1)Code describing the type of substance or medication. |
| Type | Choice of: Reference(Medication, Substance), CodeableConcept |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 130. ActivityDefinition.quantity | |
| Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
| Short | How much is administered/consumed/supplied |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity) |
| Is Modifier | false |
| Alternate Names | dose |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists()) sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty()) |
| 132. 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..0* This element is affected by the following invariants: ele-1 |
| Type | Dosage |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 134. 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 ServiceRequest.type. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site|4.0.1 (example to http://hl7.org/fhir/ValueSet/body-site|4.0.1)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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 136. ActivityDefinition.specimenRequirement | |
| Definition | Defines specimen requirements for the action to be performed, such as required specimens for a lab test. |
| Short | What specimens are required to perform this action |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | Reference(SpecimenDefinition) |
| Requirements | Needed to represent lab order definitions. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 138. ActivityDefinition.observationRequirement | |
| Definition | Defines observation requirements for the action to be performed, such as body weight or surface area. |
| Short | What observations are required to perform this action |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | Reference(ObservationDefinition) |
| Requirements | Needed to represent observation definitions. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 140. ActivityDefinition.observationResultRequirement | |
| Definition | Defines the observations that are expected to be produced by the action. |
| Short | What observations must be produced by this action |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | Reference(ObservationDefinition) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 142. 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 |
| Comments | Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | canonical(StructureMap) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 144. 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 request resource that would contain the result. |
| Short | Dynamic aspects of the definition |
| Comments | Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ActivityDefinition | |
| Definition | Atomare Aussage zu der eine Person seine Einwilligung erteilen kann |
| Short | Consent Policy |
| 2. ActivityDefinition.meta | |
| Control | 1..? |
| Must Support | true |
| 4. ActivityDefinition.meta.lastUpdated | |
| Short | updateDate |
| Control | 1..? |
| Must Support | true |
| 6. ActivityDefinition.extension:created | |
| Slice Name | created |
| Control | 0..1 |
| Type | Extension(Created) (Extension Type: instant) |
| Must Support | true |
| 8. ActivityDefinition.extension:externalProperty | |
| Slice Name | externalProperty |
| Definition | Liste frei konfigurierbarer external Properties nach dem KeyValuePrinzip zur Auswertung durch externe Anwendersysteme |
| Short | externalProperties |
| Control | 0..* |
| Type | Extension(External Property Element) (Complex Extension) |
| Must Support | true |
| Label | externalProperties |
| 10. ActivityDefinition.extension:externalProperty.extension:key | |
| Slice Name | key |
| 12. ActivityDefinition.extension:externalProperty.extension:key.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 14. ActivityDefinition.extension:externalProperty.extension:value | |
| Slice Name | value |
| 16. ActivityDefinition.extension:externalProperty.extension:value.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 18. ActivityDefinition.url | |
| Control | 0..0 |
| 20. ActivityDefinition.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 |
| 22. ActivityDefinition.version | |
| Short | version |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 1..? |
| Must Support | true |
| Label | version |
| 24. ActivityDefinition.name | |
| Definition | Name der ConsentPolicy (computer friendly) |
| Short | name |
| Control | 1..? |
| Must Support | true |
| 26. ActivityDefinition.title | |
| Definition | Bezeichnung (human friendly) |
| Short | label |
| Must Support | true |
| 28. ActivityDefinition.subtitle | |
| Control | 0..0 |
| 30. ActivityDefinition.status | |
| Definition | Bearbeitungsstatus: gICS-Äquivalente: finalized=true => active finalized=false => draft |
| Short | finalisiert ja/nein |
| Must Support | true |
| 32. ActivityDefinition.experimental | |
| Control | 0..0 |
| 34. ActivityDefinition.subject[x] | |
| Control | 0..0 |
| 36. ActivityDefinition.date | |
| Control | 0..0 |
| 38. ActivityDefinition.publisher | |
| Control | 0..0 |
| 40. ActivityDefinition.contact | |
| Control | 0..0 |
| 42. ActivityDefinition.description | |
| Definition | administrative comment |
| Short | comment |
| Must Support | true |
| 44. ActivityDefinition.useContext | |
| Definition | Verweis auf die Domäne |
| Short | domainName |
| Control | 1..1 |
| Must Support | true |
| 46. ActivityDefinition.useContext.code | |
| Must Support | true |
| 48. ActivityDefinition.useContext.code.system | |
| Control | 1..? |
| Must Support | true |
| Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
| 50. ActivityDefinition.useContext.code.code | |
| Control | 1..? |
| Must Support | true |
| Fixed Value | program |
| 52. ActivityDefinition.useContext.value[x] | |
| Type | Reference(Consent Domain) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 54. ActivityDefinition.useContext.value[x].reference | |
| Control | 1..? |
| Must Support | true |
| 56. ActivityDefinition.jurisdiction | |
| Control | 0..0 |
| 58. ActivityDefinition.purpose | |
| Control | 0..0 |
| 60. ActivityDefinition.usage | |
| Definition | administrative comment |
| Short | comment |
| Control | 0..0 |
| 62. ActivityDefinition.copyright | |
| Control | 0..0 |
| 64. ActivityDefinition.approvalDate | |
| Control | 0..0 |
| 66. ActivityDefinition.lastReviewDate | |
| Control | 0..0 |
| 68. ActivityDefinition.effectivePeriod | |
| Control | 0..0 |
| 70. ActivityDefinition.topic | |
| Control | 0..0 |
| 72. ActivityDefinition.author | |
| Control | 0..0 |
| 74. ActivityDefinition.editor | |
| Control | 0..0 |
| 76. ActivityDefinition.reviewer | |
| Control | 0..0 |
| 78. ActivityDefinition.endorser | |
| Control | 0..0 |
| 80. ActivityDefinition.relatedArtifact | |
| Control | 0..0 |
| 82. ActivityDefinition.library | |
| Control | 0..0 |
| 84. ActivityDefinition.kind | |
| Control | 0..0 |
| 86. ActivityDefinition.profile | |
| Control | 0..0 |
| 88. ActivityDefinition.code | |
| Control | 1..? |
| Binding | Unless not suitable, these codes SHALL be taken from Policy (extensible to https://ths-greifswald.de/fhir/ValueSet/gics/Policy) |
| Must Support | true |
| 90. ActivityDefinition.code.coding | |
| Control | 1..? |
| Must Support | true |
| 92. ActivityDefinition.code.coding.system | |
| Control | 1..? |
| Must Support | true |
| 94. ActivityDefinition.code.coding.code | |
| Control | 1..? |
| Must Support | true |
| 96. ActivityDefinition.intent | |
| Control | 0..0 |
| 98. ActivityDefinition.priority | |
| Control | 0..0 |
| 100. ActivityDefinition.doNotPerform | |
| Control | 0..0 |
| 102. ActivityDefinition.timing[x] | |
| Control | 0..0 |
| 104. ActivityDefinition.location | |
| Control | 0..0 |
| 106. ActivityDefinition.participant | |
| Control | 0..0 |
| 108. ActivityDefinition.product[x] | |
| Control | 0..0 |
| 110. ActivityDefinition.quantity | |
| Control | 0..0 |
| 112. ActivityDefinition.dosage | |
| Control | 0..0 |
| 114. ActivityDefinition.bodySite | |
| Control | 0..0 |
| 116. ActivityDefinition.specimenRequirement | |
| Control | 0..0 |
| 118. ActivityDefinition.observationRequirement | |
| Control | 0..0 |
| 120. ActivityDefinition.observationResultRequirement | |
| Control | 0..0 |
| 122. ActivityDefinition.transform | |
| Control | 0..0 |
| 124. ActivityDefinition.dynamicValue | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ActivityDefinition | |||||
| Definition | Atomare Aussage zu der eine Person seine Einwilligung erteilen kann | ||||
| Short | Consent Policy | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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 or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation ( name.matches('[A-Z]([A-Za-z0-9_]){0,254}')) | ||||
| 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 | ||||
| Summary | true | ||||
| 4. ActivityDefinition.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Meta | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. ActivityDefinition.meta.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 8. ActivityDefinition.meta.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. ActivityDefinition.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. ActivityDefinition.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | updateDate | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | instant | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 14. ActivityDefinition.meta.source | |||||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
| Short | Identifies where the resource comes from | ||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 16. ActivityDefinition.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | canonical(StructureDefinition) | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 18. ActivityDefinition.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. ActivityDefinition.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
| 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. 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 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. ActivityDefinition.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource and can 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 information is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 30. ActivityDefinition.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. ActivityDefinition.extension:created | |||||
| Slice Name | created | ||||
| Definition | Erstellungsdatum der Ressource/Information | ||||
| Short | Created | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Created) (Extension Type: instant) | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 34. ActivityDefinition.extension:externalProperty | |||||
| Slice Name | externalProperty | ||||
| Definition | Liste frei konfigurierbarer external Properties nach dem KeyValuePrinzip zur Auswertung durch externe Anwendersysteme | ||||
| Short | externalProperties | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(External Property Element) (Complex Extension) | ||||
| Must Support | true | ||||
| Label | externalProperties | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 36. ActivityDefinition.extension:externalProperty.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 38. ActivityDefinition.extension:externalProperty.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 2..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 40. ActivityDefinition.extension:externalProperty.extension:key | |||||
| Slice Name | key | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Label | Key | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 42. ActivityDefinition.extension:externalProperty.extension:key.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 44. ActivityDefinition.extension:externalProperty.extension:key.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 46. ActivityDefinition.extension:externalProperty.extension:key.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Fixed Value | key | ||||
| 48. ActivityDefinition.extension:externalProperty.extension:key.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. ActivityDefinition.extension:externalProperty.extension:value | |||||
| Slice Name | value | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Label | Value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 52. ActivityDefinition.extension:externalProperty.extension:value.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 54. ActivityDefinition.extension:externalProperty.extension:value.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 56. ActivityDefinition.extension:externalProperty.extension:value.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Fixed Value | value | ||||
| 58. ActivityDefinition.extension:externalProperty.extension:value.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. ActivityDefinition.extension:externalProperty.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Fixed Value | https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty | ||||
| 62. ActivityDefinition.extension:externalProperty.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. ActivityDefinition.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 66. 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. | ||||
| Short | Canonical identifier for this activity definition, represented as a URI (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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. 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, and can then 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..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 70. 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 | version | ||||
| 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 reference 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 | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Label | version | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. ActivityDefinition.name | |||||
| Definition | Name der ConsentPolicy (computer friendly) | ||||
| Short | name | ||||
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, inv-0 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Support human navigation and code generation. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. ActivityDefinition.title | |||||
| Definition | Bezeichnung (human friendly) | ||||
| Short | label | ||||
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. ActivityDefinition.subtitle | |||||
| Definition | An explanatory or alternate title for the activity definition giving additional information about its content. | ||||
| Short | Subordinate title of the activity definition | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. ActivityDefinition.status | |||||
| Definition | Bearbeitungsstatus: gICS-Äquivalente: finalized=true => active finalized=false => draft | ||||
| Short | finalisiert ja/nein | ||||
| Comments | Allows filtering of activity definitions that are appropriate for use versus not. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)The lifecycle status of an artifact. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. 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 definitions that are appropriate for use versus not. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. ActivityDefinition.subject[x] | |||||
| Definition | A code or group definition that describes the intended subject of the activity being defined. | ||||
| Short | Type of individual the activity definition is intended for | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||
| Type | Choice of: CodeableConcept, Reference(Group) | ||||
| Meaning if Missing | Patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. ActivityDefinition.date | |||||
| Definition | The date (and optionally time) when the activity definition was published. The date must change 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 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..0 This element is affected by the following invariants: ele-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Revision Date | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. ActivityDefinition.publisher | |||||
| Definition | The name of the organization or individual 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..0 This element is affected by the following invariants: ele-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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 88. 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..0 This element is affected by the following invariants: ele-1 | ||||
| Type | ContactDetail | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. ActivityDefinition.description | |||||
| Definition | administrative comment | ||||
| Short | comment | ||||
| 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 activity definition is presumed to be the predominant language in the place the activity definition was created). | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 92. ActivityDefinition.useContext | |||||
| Definition | Verweis auf die Domäne | ||||
| Short | domainName | ||||
| Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | UsageContext | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Assist in searching for appropriate content. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 94. ActivityDefinition.useContext.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 96. ActivityDefinition.useContext.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 98. ActivityDefinition.useContext.code | |||||
| Definition | A code that identifies the type of context being specified by this usage context. | ||||
| Short | Type of context being specified | ||||
| Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from UsageContextType (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|4.0.1)A code that specifies a type of context being specified by a usage context. | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. ActivityDefinition.useContext.code.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 102. ActivityDefinition.useContext.code.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.useContext.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 104. ActivityDefinition.useContext.code.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 106. ActivityDefinition.useContext.code.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 108. ActivityDefinition.useContext.code.code | |||||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Fixed Value | program | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 110. ActivityDefinition.useContext.code.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 112. ActivityDefinition.useContext.code.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 114. ActivityDefinition.useContext.value[x] | |||||
| Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. | ||||
| Short | Value that defines the context | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Consent Domain) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 116. ActivityDefinition.useContext.value[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 | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 118. ActivityDefinition.useContext.value[x].extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.useContext.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 120. ActivityDefinition.useContext.value[x].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 | 1..1 This element is affected by the following invariants: ele-1, ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 122. ActivityDefinition.useContext.value[x].type | |||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
| Short | Type the reference refers to (e.g. "Patient") | ||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)Aa resource (or, for logical models, the URI of the logical model). | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 124. ActivityDefinition.useContext.value[x].identifier | |||||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 126. ActivityDefinition.useContext.value[x].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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 128. 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..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1)Countries and regions within which this artifact is targeted for use. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 130. ActivityDefinition.purpose | |||||
| Definition | Explanation 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..0 This element is affected by the following invariants: ele-1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 132. ActivityDefinition.usage | |||||
| Definition | administrative comment | ||||
| Short | comment | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 134. 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 | ||||
| Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ | ||||
| Control | 0..0 This element is affected by the following invariants: ele-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 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 136. 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 or editorial corrections. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | date | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 138. ActivityDefinition.lastReviewDate | |||||
| Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||
| Short | When the activity definition was last reviewed | ||||
| Comments | If specified, this date follows the original approval date. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 140. 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..0 This element is affected by the following invariants: ele-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 the activity definition are or are expected to be used instead. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 142. 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. | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see DefinitionTopic (example to http://hl7.org/fhir/ValueSet/definition-topic|4.0.1)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 activity definition so that it can be found by topical searches. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 144. ActivityDefinition.author | |||||
| Definition | An individiual or organization primarily involved in the creation and maintenance of the content. | ||||
| Short | Who authored the content | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | ContactDetail | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 146. ActivityDefinition.editor | |||||
| Definition | An individual or organization primarily responsible for internal coherence of the content. | ||||
| Short | Who edited the content | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | ContactDetail | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 148. ActivityDefinition.reviewer | |||||
| Definition | An individual or organization primarily responsible for review of some aspect of the content. | ||||
| Short | Who reviewed the content | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | ContactDetail | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 150. ActivityDefinition.endorser | |||||
| Definition | An individual or organization responsible for officially endorsing the content for use in some setting. | ||||
| Short | Who endorsed the content | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | ContactDetail | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 152. 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..0 This element is affected by the following invariants: ele-1 | ||||
| Type | RelatedArtifact | ||||
| Requirements | Activity definitions 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 154. ActivityDefinition.library | |||||
| Definition | A reference to a Library resource containing any formal logic used by the activity definition. | ||||
| Short | Logic used by the activity definition | ||||
| Comments | |||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | canonical(Library) | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 156. ActivityDefinition.kind | |||||
| Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, 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..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from RequestResourceType (required to http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1)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 | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 158. ActivityDefinition.profile | |||||
| Definition | A profile to which the target of the activity definition is expected to conform. | ||||
| Short | What profile the resource needs to conform to | ||||
| Comments | |||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | canonical(StructureDefinition) | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 160. 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 | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Policy (extensible to https://ths-greifswald.de/fhir/ValueSet/gics/Policy) | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows matching performed to planned as well as validation against protocols. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 162. ActivityDefinition.code.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 164. ActivityDefinition.code.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 166. ActivityDefinition.code.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 168. ActivityDefinition.code.coding.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 170. ActivityDefinition.code.coding.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on ActivityDefinition.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 172. ActivityDefinition.code.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 174. ActivityDefinition.code.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 176. ActivityDefinition.code.coding.code | |||||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 178. ActivityDefinition.code.coding.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 180. ActivityDefinition.code.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 182. ActivityDefinition.code.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 184. ActivityDefinition.intent | |||||
| Definition | Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. | ||||
| Short | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from RequestIntent (required to http://hl7.org/fhir/ValueSet/request-intent|4.0.1)Codes indicating the degree of authority/intentionality associated with a request. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 186. ActivityDefinition.priority | |||||
| Definition | Indicates how quickly the activity should be addressed with respect to other requests. | ||||
| Short | routine | urgent | asap | stat | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)Identifies the level of importance to be assigned to actioning the request. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 188. ActivityDefinition.doNotPerform | |||||
| Definition | Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. | ||||
| Short | True if the activity should not be performed | ||||
| Comments | This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestGroup. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 190. 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..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Choice of: Timing, dateTime, Age, Period, Range, Duration | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 192. 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..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Location) | ||||
| Requirements | Helps in planning of activity. | ||||
| Alternate Names | facility | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 194. ActivityDefinition.participant | |||||
| Definition | Indicates who should participate in performing the action described. | ||||
| Short | Who should participate in the action | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 201. 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..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTMedicationCodes (example to http://hl7.org/fhir/ValueSet/medication-codes|4.0.1)Code describing the type of substance or medication. | ||||
| Type | Choice of: Reference(Medication, Substance), CodeableConcept | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 203. ActivityDefinition.quantity | |||||
| Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). | ||||
| Short | How much is administered/consumed/supplied | ||||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Alternate Names | dose | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 205. 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..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Dosage | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 207. 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 ServiceRequest.type. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTBodyStructures (example to http://hl7.org/fhir/ValueSet/body-site|4.0.1)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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 209. ActivityDefinition.specimenRequirement | |||||
| Definition | Defines specimen requirements for the action to be performed, such as required specimens for a lab test. | ||||
| Short | What specimens are required to perform this action | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(SpecimenDefinition) | ||||
| Requirements | Needed to represent lab order definitions. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 211. ActivityDefinition.observationRequirement | |||||
| Definition | Defines observation requirements for the action to be performed, such as body weight or surface area. | ||||
| Short | What observations are required to perform this action | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(ObservationDefinition) | ||||
| Requirements | Needed to represent observation definitions. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 213. ActivityDefinition.observationResultRequirement | |||||
| Definition | Defines the observations that are expected to be produced by the action. | ||||
| Short | What observations must be produced by this action | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(ObservationDefinition) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 215. 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 | ||||
| Comments | Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | canonical(StructureMap) | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 217. 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 request resource that would contain the result. | ||||
| Short | Dynamic aspects of the definition | ||||
| Comments | Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||