ITB - Online appointment booking service
1.0.0 - Initial Release
ITB - Online appointment booking service
1.0.0 - Initial Release
ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions
| Active as of 2026-04-20 |
Definitions for the activity-definition-portal resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ActivityDefinition | ||||||||||
| Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. | |||||||||
| Short | The definition of a specific activity to be taken, independent of any particular patient or context | |||||||||
| Control | 0..* | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | 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}'))dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) 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 | |||||||||
| Type | Meta | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 4. ActivityDefinition.meta.versionId | ||||||||||
| Definition | The technical resource version supplied by the server for change tracking of this specific ActivityDefinitionPortal instance. 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 | Server-managed resource versionVersion 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 | |||||||||
| Type | id | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 6. ActivityDefinition.meta.profile | ||||||||||
| Definition | Identifies that the resource conforms to ActivityDefinitionPortal so clients can safely process it as the WOF Portal service concept profile. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | |||||||||
| Short | Profile declaration for this portal resourceProfiles 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 | 10..* | |||||||||
| Type | canonical(StructureDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 8. 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..01 | |||||||||
| 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())) | |||||||||
| 10. 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..01 | |||||||||
| Binding | The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1 (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| |||||||||
| Type | code | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 12. ActivityDefinition.extension:sortKey | ||||||||||
| Slice Name | sortKey | |||||||||
| Definition | Sort key used to order the service concept consistently in portal presentation. | |||||||||
| Short | Portal-specific sort key | |||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||
| Type | Extension(Sort Key) (Extension Type: integer) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||
| 14. ActivityDefinition.extension:campaigns | ||||||||||
| Slice Name | campaigns | |||||||||
| Definition | Campaign identifiers associated with the service concept, represented as repeated campaign codes. | |||||||||
| Short | Campaign identifiers for the service | |||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||
| Type | Extension(Campaigns) (Complex Extension) | |||||||||
| Is Modifier | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 16. 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..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | |||||||||
| Summary | false | |||||||||
| 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()) | |||||||||
| 18. 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* | |||||||||
| Type | Identifier | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 20. ActivityDefinition.title | ||||||||||
| Definition | The user-facing title used to present the service concept in search results, booking flows, and other portal views. A short, descriptive, user-friendly title for the activity definition. | |||||||||
| Short | Human-readable title for the serviceName 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 | 10..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 22. 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 | |||||||||
| Control | 0..01 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 24. ActivityDefinition.status | ||||||||||
| Definition | The lifecycle status of the ActivityDefinitionPortal definition, for example whether the service concept is active. The status of this activity definition. Enables tracking the life-cycle of the content. | |||||||||
| Short | Publication status of the service conceptdraft | active | retired | unknown | |||||||||
| Comments | Allows filtering of activity definitions that are appropriate for use versus not. | |||||||||
| Control | 1..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 | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 26. 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 | |||||||||
| Type | boolean | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 28. 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 | |||||||||
| 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) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Meaning if Missing | Patient | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 30. ActivityDefinition.date | ||||||||||
| Definition | The publication or business version date for this service definition. Clients may use it to understand when the definition was last updated by the publisher. 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 | Business version date for the definitionDate 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 | 10..1 | |||||||||
| Type | dateTime | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Alternate Names | Revision Date | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 32. ActivityDefinition.description | ||||||||||
| Definition | A human-readable description of the service concept intended for presentation A free text natural language description of the activity definition from a consumer's perspective. | |||||||||
| Short | Presentation description of the serviceNatural 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 | |||||||||
| Type | markdown | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 34. ActivityDefinition.useContext | ||||||||||
| Definition | 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 | The 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 | 0..0* | |||||||||
| Type | UsageContext | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 36. 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* | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 38. 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 | |||||||||
| Type | markdown | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 40. ActivityDefinition.usage | ||||||||||
| Definition | A detailed description of how the activity definition is used from a clinical perspective. | |||||||||
| Short | Describes the clinical usage of the activity definition | |||||||||
| Control | 0..01 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 42. ActivityDefinition.copyright | ||||||||||
| Definition | A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. | |||||||||
| Short | Use and/or publishing restrictions | |||||||||
| Control | 0..01 | |||||||||
| Type | markdown | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 44. 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 | |||||||||
| Type | date | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 46. 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 | |||||||||
| Type | date | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 48. 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 | |||||||||
| Type | Period | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 50. ActivityDefinition.topic | ||||||||||
| Definition | Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. | |||||||||
| Short | E.g. Education, Treatment, Assessment, etc. | |||||||||
| Control | 0..0* | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 52. 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* | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 54. ActivityDefinition.editor | ||||||||||
| Definition | An individual or organization primarily responsible for internal coherence of the content. | |||||||||
| Short | Who edited the content | |||||||||
| Control | 0..0* | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 56. 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* | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 58. 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* | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 60. 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* | |||||||||
| Type | RelatedArtifact | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 62. 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 | |||||||||
| Control | 0..0* | |||||||||
| Type | canonical(Library) | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 64. ActivityDefinition.kind | ||||||||||
| Definition | The request resource type represented by this service concept. In WOF Portal this is fixed to ServiceRequest. 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 | Target request type for the serviceKind of resource | |||||||||
| Comments | May determine what types of extensions are permitted. | |||||||||
| Control | 10..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 | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Pattern Value | ServiceRequest | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 66. ActivityDefinition.code | ||||||||||
| Definition | The business code that uniquely identifies the shared service concept. Booking and interoperability use this code rather than the FHIR resource id. Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||||||
| Short | Booking activity code for the serviceDetail type of activity | |||||||||
| Comments | Tends to be less relevant for activities involving particular products. | |||||||||
| Control | 10..1 | |||||||||
| Binding | For example codes, see ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code|4.0.1 (example to http://hl7.org/fhir/ValueSet/procedure-code|4.0.1)Detailed type of the activity; e.g. CBC. | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| 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())) | |||||||||
| 68. ActivityDefinition.code.coding | ||||||||||
| Definition | The coding that carries the booking activity code for the service concept. A reference to a code defined by a terminology system. | |||||||||
| Short | Coded representation of the service conceptCode 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..1* | |||||||||
| Type | Coding | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| Slicing | This element introduces a set of slices on ActivityDefinition.code.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 70. 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 | |||||||||
| Control | 0..01 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 72. ActivityDefinition.code.coding:serviceTypeId | ||||||||||
| Slice Name | serviceTypeId | |||||||||
| Definition | The coding that carries the booking activity code for the service concept. A reference to a code defined by a terminology system. | |||||||||
| Short | Coded representation of the service conceptCode 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..1* | |||||||||
| Type | Coding | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 74. ActivityDefinition.code.coding:serviceTypeId.system | ||||||||||
| Definition | The coding system for the booking activity code. The server SHALL populate this with the WOF Connect service-type-id code system. The identification of the code system that defines the meaning of the symbol in the code. | |||||||||
| Short | WOF Connect service type code systemIdentity 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 | |||||||||
| Type | uri | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||||||||
| Pattern Value | http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 76. ActivityDefinition.code.coding:serviceTypeId.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 | |||||||||
| Control | 0..01 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 78. 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 | |||||||||
| Control | 0..01 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 80. ActivityDefinition.priority | ||||||||||
| Definition | Indicates how quickly the activity should be addressed with respect to other requests. | |||||||||
| Short | routine | urgent | asap | stat | |||||||||
| Control | 0..01 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 82. 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 | |||||||||
| 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())) | |||||||||
| 84. 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 | |||||||||
| Type | Choice of: Timing, dateTime, Age, Period, Range, Duration | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 86. 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 | |||||||||
| Type | Reference(Location) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 88. ActivityDefinition.participant | ||||||||||
| Definition | Indicates who should participate in performing the action described. | |||||||||
| Short | Who should participate in the action | |||||||||
| Control | 0..0* | |||||||||
| Type | BackboneElement | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 92. 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 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 94. ActivityDefinition.quantity | ||||||||||
| Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). | |||||||||
| Short | How much is administered/consumed/supplied | |||||||||
| Control | 0..01 | |||||||||
| Type | Quantity(SimpleQuantity) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | dose | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 96. 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* | |||||||||
| Type | Dosage | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 98. 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* | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 100. 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 | |||||||||
| Control | 0..0* | |||||||||
| Type | Reference(SpecimenDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 102. 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 | |||||||||
| Control | 0..0* | |||||||||
| Type | Reference(ObservationDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Requirements | Needed to represent observation definitions. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 104. ActivityDefinition.observationResultRequirement | ||||||||||
| Definition | Defines the observations that are expected to be produced by the action. | |||||||||
| Short | What observations must be produced by this action | |||||||||
| Control | 0..0* | |||||||||
| Type | Reference(ObservationDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 106. 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 | |||||||||
| Type | canonical(StructureMap) | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 108. 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* | |||||||||
| Type | BackboneElement | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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 | |
| 2. ActivityDefinition.meta | |
| 4. ActivityDefinition.meta.versionId | |
| Definition | The technical resource version supplied by the server for change tracking of this specific ActivityDefinitionPortal instance. |
| 6. ActivityDefinition.meta.profile | |
| Definition | Identifies that the resource conforms to ActivityDefinitionPortal so clients can safely process it as the WOF Portal service concept profile. |
| 8. ActivityDefinition.title | |
| Control | 1..? |
| 10. ActivityDefinition.status | |
| Definition | The lifecycle status of the ActivityDefinitionPortal definition, for example whether the service concept is active. |
| 12. ActivityDefinition.code | |
| 14. ActivityDefinition.code.coding | |
| Control | 0..1 |
| Slicing | This element introduces a set of slices on ActivityDefinition.code.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. ActivityDefinition.code.coding.display | |
| Control | 0..0 |
| 18. ActivityDefinition.code.coding:serviceTypeId | |
| Slice Name | serviceTypeId |
| Control | 1..1 |
| 20. ActivityDefinition.code.coding:serviceTypeId.system | |
| Control | 1..? |
| Pattern Value | http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id |
| 22. ActivityDefinition.code.coding:serviceTypeId.display | |
| Control | 0..0 |
| 24. ActivityDefinition.timing[x] | |
| Control | 0..0 |
| 26. ActivityDefinition.participant | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ActivityDefinition | ||||||||||
| Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. | |||||||||
| Short | The definition of a specific activity to be taken, independent of any particular patient or context | |||||||||
| Control | 0..* | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | 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}'))dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources ( contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| 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 | |||||||||
| Type | Meta | |||||||||
| Is Modifier | false | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 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..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| Slicing | This element introduces a set of slices on ActivityDefinition.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 10. ActivityDefinition.meta.versionId | ||||||||||
| Definition | The technical resource version supplied by the server for change tracking of this specific ActivityDefinitionPortal instance. | |||||||||
| Short | Server-managed resource version | |||||||||
| 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 | |||||||||
| Type | id | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| 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 | When 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 | 0..1 | |||||||||
| Type | instant | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 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 | |||||||||
| Type | uri | |||||||||
| Is Modifier | false | |||||||||
| 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 | Identifies that the resource conforms to ActivityDefinitionPortal so clients can safely process it as the WOF Portal service concept profile. | |||||||||
| Short | Profile declaration for this portal resource | |||||||||
| 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 | 1..* | |||||||||
| Type | canonical(StructureDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| 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..* | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| 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..* | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| 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..0 | |||||||||
| 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..0 | |||||||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| |||||||||
| Type | code | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 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 | |||||||||
| Type | Narrative | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | inline resources, anonymous resources, contained resources | |||||||||
| 30. ActivityDefinition.extension | ||||||||||
| Definition | An Extension | |||||||||
| Short | Extension | |||||||||
| Control | 0..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| Slicing | This element introduces a set of slices on ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 32. ActivityDefinition.extension:sortKey | ||||||||||
| Slice Name | sortKey | |||||||||
| Definition | Sort key used to order the service concept consistently in portal presentation. | |||||||||
| Short | Portal-specific sort key | |||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||
| Type | Extension(Sort Key) (Extension Type: integer) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 34. ActivityDefinition.extension:campaigns | ||||||||||
| Slice Name | campaigns | |||||||||
| Definition | Campaign identifiers associated with the service concept, represented as repeated campaign codes. | |||||||||
| Short | Campaign identifiers for the service | |||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||
| Type | Extension(Campaigns) (Complex Extension) | |||||||||
| Is Modifier | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| 36. 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..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | |||||||||
| Summary | false | |||||||||
| 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()) | |||||||||
| 38. 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..1 | |||||||||
| Type | uri | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 40. 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 | |||||||||
| Type | Identifier | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 42. ActivityDefinition.version | ||||||||||
| Definition | The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. | |||||||||
| Short | Business version of the activity definition | |||||||||
| Comments | There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a 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 | 0..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 44. ActivityDefinition.name | ||||||||||
| Definition | A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |||||||||
| Short | Name for this activity definition (computer friendly) | |||||||||
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | |||||||||
| Control | 0..1 This element is affected by the following invariants: inv-0 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| 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())) | |||||||||
| 46. ActivityDefinition.title | ||||||||||
| Definition | The user-facing title used to present the service concept in search results, booking flows, and other portal views. | |||||||||
| Short | Human-readable title for the service | |||||||||
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | |||||||||
| Control | 1..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 48. 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 | |||||||||
| Control | 0..0 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 50. ActivityDefinition.status | ||||||||||
| Definition | The lifecycle status of the ActivityDefinitionPortal definition, for example whether the service concept is active. | |||||||||
| Short | Publication status of the service concept | |||||||||
| Comments | Allows filtering of activity definitions that are appropriate for use versus not. | |||||||||
| Control | 1..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 | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 52. 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 | |||||||||
| Type | boolean | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 54. 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 | |||||||||
| 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) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Meaning if Missing | Patient | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 56. ActivityDefinition.date | ||||||||||
| Definition | The publication or business version date for this service definition. Clients may use it to understand when the definition was last updated by the publisher. | |||||||||
| Short | Business version date for the definition | |||||||||
| 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 | 1..1 | |||||||||
| Type | dateTime | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Alternate Names | Revision Date | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 58. 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..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 60. ActivityDefinition.contact | ||||||||||
| Definition | Contact details to assist a user in finding and communicating with the publisher. | |||||||||
| Short | Contact details for the publisher | |||||||||
| Comments | May be a web site, an email address, a telephone number, etc. | |||||||||
| Control | 0..* | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 62. ActivityDefinition.description | ||||||||||
| Definition | A human-readable description of the service concept intended for presentation | |||||||||
| Short | Presentation description of the service | |||||||||
| 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 | |||||||||
| Type | markdown | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 64. ActivityDefinition.useContext | ||||||||||
| Definition | 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 | The 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 | 0..0 | |||||||||
| Type | UsageContext | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 66. 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 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 68. 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 | |||||||||
| Type | markdown | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 70. ActivityDefinition.usage | ||||||||||
| Definition | A detailed description of how the activity definition is used from a clinical perspective. | |||||||||
| Short | Describes the clinical usage of the activity definition | |||||||||
| Control | 0..0 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 72. ActivityDefinition.copyright | ||||||||||
| Definition | A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. | |||||||||
| Short | Use and/or publishing restrictions | |||||||||
| Control | 0..0 | |||||||||
| Type | markdown | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 74. 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 | |||||||||
| Type | date | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 76. 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 | |||||||||
| Type | date | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 78. 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 | |||||||||
| Type | Period | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 80. ActivityDefinition.topic | ||||||||||
| Definition | Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. | |||||||||
| Short | E.g. Education, Treatment, Assessment, etc. | |||||||||
| Control | 0..0 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 82. 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 | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 84. ActivityDefinition.editor | ||||||||||
| Definition | An individual or organization primarily responsible for internal coherence of the content. | |||||||||
| Short | Who edited the content | |||||||||
| Control | 0..0 | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 86. 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 | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 88. 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 | |||||||||
| Type | ContactDetail | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 90. 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 | |||||||||
| Type | RelatedArtifact | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 92. 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 | |||||||||
| Control | 0..0 | |||||||||
| Type | canonical(Library) | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 94. ActivityDefinition.kind | ||||||||||
| Definition | The request resource type represented by this service concept. In WOF Portal this is fixed to ServiceRequest. | |||||||||
| Short | Target request type for the service | |||||||||
| Comments | May determine what types of extensions are permitted. | |||||||||
| Control | 1..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 | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Pattern Value | ServiceRequest | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 96. 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 | |||||||||
| Control | 0..1 | |||||||||
| Type | canonical(StructureDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 98. ActivityDefinition.code | ||||||||||
| Definition | The business code that uniquely identifies the shared service concept. Booking and interoperability use this code rather than the FHIR resource id. | |||||||||
| Short | Booking activity code for the service | |||||||||
| Comments | Tends to be less relevant for activities involving particular products. | |||||||||
| Control | 1..1 | |||||||||
| Binding | For example codes, see ProcedureCodes(SNOMEDCT) (example to http://hl7.org/fhir/ValueSet/procedure-code|4.0.1)Detailed type of the activity; e.g. CBC. | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| 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())) | |||||||||
| 100. 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 | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 102. 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..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| Slicing | This element introduces a set of slices on ActivityDefinition.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 104. ActivityDefinition.code.coding | ||||||||||
| Definition | The coding that carries the booking activity code for the service concept. | |||||||||
| Short | Coded representation of the service concept | |||||||||
| 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..1 | |||||||||
| Type | Coding | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| Slicing | This element introduces a set of slices on ActivityDefinition.code.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 106. 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 | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 108. 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..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| Slicing | This element introduces a set of slices on ActivityDefinition.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 110. ActivityDefinition.code.coding.system | ||||||||||
| Definition | The coding system for the booking activity code. The server SHALL populate this with the WOF Connect service-type-id code system. | |||||||||
| Short | WOF Connect service type code 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 | 0..1 | |||||||||
| Type | uri | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| 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.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 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 114. ActivityDefinition.code.coding.code | ||||||||||
| Definition | The code value that uniquely identifies the shared service concept within the WOF Connect service-type-id code system. This is the only coded value the client is required to populate. | |||||||||
| Short | Service type identifier | |||||||||
| Control | 0..1 | |||||||||
| Type | code | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Obligations |
| |||||||||
| 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())) | |||||||||
| 116. 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 | |||||||||
| Control | 0..0 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 118. 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 | |||||||||
| Type | boolean | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 120. ActivityDefinition.code.coding:serviceTypeId | ||||||||||
| Slice Name | serviceTypeId | |||||||||
| Definition | The coding that carries the booking activity code for the service concept. | |||||||||
| Short | Coded representation of the service concept | |||||||||
| 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..1 | |||||||||
| Type | Coding | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 122. ActivityDefinition.code.coding:serviceTypeId.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 | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 124. ActivityDefinition.code.coding:serviceTypeId.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..* | |||||||||
| Type | Extension | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | extensions, user content | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||
| Slicing | This element introduces a set of slices on ActivityDefinition.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 126. ActivityDefinition.code.coding:serviceTypeId.system | ||||||||||
| Definition | The coding system for the booking activity code. The server SHALL populate this with the WOF Connect service-type-id code system. | |||||||||
| Short | WOF Connect service type code 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 | |||||||||
| Type | uri | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||||||||
| Pattern Value | http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 128. ActivityDefinition.code.coding:serviceTypeId.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 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 130. ActivityDefinition.code.coding:serviceTypeId.code | ||||||||||
| Definition | The code value that uniquely identifies the shared service concept within the WOF Connect service-type-id code system. This is the only coded value the client is required to populate. | |||||||||
| Short | Service type identifier | |||||||||
| Control | 0..1 | |||||||||
| Type | code | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Obligations |
| |||||||||
| 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())) | |||||||||
| 132. ActivityDefinition.code.coding:serviceTypeId.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 | |||||||||
| Control | 0..0 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 134. ActivityDefinition.code.coding:serviceTypeId.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 | |||||||||
| Type | boolean | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 136. 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 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| 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())) | |||||||||
| 138. 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 | |||||||||
| Control | 0..0 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 140. ActivityDefinition.priority | ||||||||||
| Definition | Indicates how quickly the activity should be addressed with respect to other requests. | |||||||||
| Short | routine | urgent | asap | stat | |||||||||
| Control | 0..0 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 142. 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 | |||||||||
| 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())) | |||||||||
| 144. 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 | |||||||||
| Type | Choice of: Timing, dateTime, Age, Period, Range, Duration | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 146. 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 | |||||||||
| Type | Reference(Location) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 148. ActivityDefinition.participant | ||||||||||
| Definition | Indicates who should participate in performing the action described. | |||||||||
| Short | Who should participate in the action | |||||||||
| Control | 0..0 | |||||||||
| Type | BackboneElement | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 155. 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 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 157. ActivityDefinition.quantity | ||||||||||
| Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). | |||||||||
| Short | How much is administered/consumed/supplied | |||||||||
| Control | 0..0 | |||||||||
| Type | Quantity(SimpleQuantity) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Alternate Names | dose | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 159. 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 | |||||||||
| Type | Dosage | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 161. 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 | |||||||||
| 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 | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 163. 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 | |||||||||
| Control | 0..0 | |||||||||
| Type | Reference(SpecimenDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| 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())) | |||||||||
| 165. 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 | |||||||||
| Control | 0..0 | |||||||||
| Type | Reference(ObservationDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Requirements | Needed to represent observation definitions. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 167. ActivityDefinition.observationResultRequirement | ||||||||||
| Definition | Defines the observations that are expected to be produced by the action. | |||||||||
| Short | What observations must be produced by this action | |||||||||
| Control | 0..0 | |||||||||
| Type | Reference(ObservationDefinition) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 169. 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 | |||||||||
| Type | canonical(StructureMap) | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 171. 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 | |||||||||
| Type | BackboneElement | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||