Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.15.0 - ci-build
NL
Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v0.15.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2ActivityDefinition | Version: 0.15.0 | |||
| Draft as of 2025-10-07 |
Realm: |
Computable Name: KT2_ActivityDefinition | ||
Copyright/Legal: VZVZ |
||||
The (FHIR) ActivityDefinition (resource) describes an eHealth activity that is available for assignment to a patient. When assigning an eHealth activity to a patient, an eHealth Task is created, in which sub-activities are included as contained resources that refer to the main task via Task.partOf.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ActivityDefinition | Description of an eHealth activity Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, adf-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() ![]() |
1..* | Reference(KT2_Endpoint) | Endpoint to the service application URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension | |
![]() ![]() ![]() |
0..1 | id | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) |
![]() ![]() |
Σ | 1..1 | string | Name for this activity definition (human friendly) |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | |
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | Optional expansion for the activity |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: koppeltaal-expansion | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Closed by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The specific expansion Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities |
![]() ![]() |
0..* | CodeableConcept | E.g. Self-Treatment and Self-Assessment, etc. Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities | |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | |
| ActivityDefinition.useContext.code | required | KoppeltaalUsageContextType_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | |
| ActivityDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextFrom the FHIR Standard | |
| ActivityDefinition.useContext:koppeltaal-expansion.code | required | Pattern Value: koppeltaal-expansionhttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | |
| ActivityDefinition.useContext:koppeltaal-expansion.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextFrom the FHIR Standard | |
| ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConcept | required | KoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)http://vzvz.nl/fhir/ValueSet/koppeltaal-expansionFrom this IG | |
| ActivityDefinition.topic | extensible | KoppeltaalDefinitionTopic_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topicFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| adf-0 | warning | ActivityDefinition | 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 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ActivityDefinition | 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 | error | ActivityDefinition | 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 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ActivityDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| exp-1 | error | ActivityDefinition.dynamicValue.expression | An expression or a reference must be provided : expression.exists() or reference.exists() |
This structure is derived from ActivityDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ActivityDefinition | Description of an eHealth activity | |
![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() ![]() |
1..* | Reference(KT2_Endpoint) | Endpoint to the service application URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension | |
![]() ![]() ![]() |
0..* | id | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId | |
![]() ![]() |
1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | |
![]() ![]() |
1..1 | string | Name for this activity definition (human friendly) | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types | |
![]() ![]() ![]() |
0..* | UsageContext | Optional expansion for the activity | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Usage context type including Koppeltaal extensions Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: koppeltaal-expansion | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The specific expansion Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | CodeableConcept | E.g. Self-Treatment and Self-Assessment, etc. Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ActivityDefinition.useContext.code | required | KoppeltaalUsageContextType_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | |
| ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConcept | required | KoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)http://vzvz.nl/fhir/ValueSet/koppeltaal-expansionFrom this IG | |
| ActivityDefinition.topic | extensible | KoppeltaalDefinitionTopic_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topicFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ActivityDefinition | Description of an eHealth activity Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, adf-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
![]() ![]() ![]() |
1..* | Reference(KT2_Endpoint) | Endpoint to the service application URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension | |||||
![]() ![]() ![]() |
0..1 | id | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the activity definition | ||||
![]() ![]() |
ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
![]() ![]() |
Σ | 1..1 | string | Name for this activity definition (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the activity definition | |||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | Optional expansion for the activity | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: koppeltaal-expansion | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Closed by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The specific expansion Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Self-Treatment and Self-Assessment, etc. Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. | ||||
![]() ![]() |
0..* | BackboneElement | Who should participate in the action | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ActivityDefinition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | ||||
| ActivityDefinition.useContext.code | required | KoppeltaalUsageContextType_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | ||||
| ActivityDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextFrom the FHIR Standard | ||||
| ActivityDefinition.useContext:koppeltaal-expansion.code | required | Pattern Value: koppeltaal-expansionhttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | ||||
| ActivityDefinition.useContext:koppeltaal-expansion.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextFrom the FHIR Standard | ||||
| ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConcept | required | KoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)http://vzvz.nl/fhir/ValueSet/koppeltaal-expansionFrom this IG | ||||
| ActivityDefinition.topic | extensible | KoppeltaalDefinitionTopic_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topicFrom this IG | ||||
| ActivityDefinition.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | ||||
| ActivityDefinition.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1From the FHIR Standard | ||||
| ActivityDefinition.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-roleFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| adf-0 | warning | ActivityDefinition | 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 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ActivityDefinition | 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 | error | ActivityDefinition | 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 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ActivityDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| exp-1 | error | ActivityDefinition.dynamicValue.expression | An expression or a reference must be provided : expression.exists() or reference.exists() |
This structure is derived from ActivityDefinition
Summary
Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 34 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ActivityDefinition | Description of an eHealth activity Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, adf-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() ![]() |
1..* | Reference(KT2_Endpoint) | Endpoint to the service application URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension | |
![]() ![]() ![]() |
0..1 | id | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) |
![]() ![]() |
Σ | 1..1 | string | Name for this activity definition (human friendly) |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | |
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | Optional expansion for the activity |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: koppeltaal-expansion | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Closed by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The specific expansion Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities |
![]() ![]() |
0..* | CodeableConcept | E.g. Self-Treatment and Self-Assessment, etc. Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities | |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | |
| ActivityDefinition.useContext.code | required | KoppeltaalUsageContextType_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | |
| ActivityDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextFrom the FHIR Standard | |
| ActivityDefinition.useContext:koppeltaal-expansion.code | required | Pattern Value: koppeltaal-expansionhttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | |
| ActivityDefinition.useContext:koppeltaal-expansion.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextFrom the FHIR Standard | |
| ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConcept | required | KoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)http://vzvz.nl/fhir/ValueSet/koppeltaal-expansionFrom this IG | |
| ActivityDefinition.topic | extensible | KoppeltaalDefinitionTopic_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topicFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| adf-0 | warning | ActivityDefinition | 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 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ActivityDefinition | 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 | error | ActivityDefinition | 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 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ActivityDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| exp-1 | error | ActivityDefinition.dynamicValue.expression | An expression or a reference must be provided : expression.exists() or reference.exists() |
Differential View
This structure is derived from ActivityDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ActivityDefinition | Description of an eHealth activity | |
![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() ![]() |
1..* | Reference(KT2_Endpoint) | Endpoint to the service application URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension | |
![]() ![]() ![]() |
0..* | id | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId | |
![]() ![]() |
1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | |
![]() ![]() |
1..1 | string | Name for this activity definition (human friendly) | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types | |
![]() ![]() ![]() |
0..* | UsageContext | Optional expansion for the activity | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Usage context type including Koppeltaal extensions Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: koppeltaal-expansion | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The specific expansion Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | CodeableConcept | E.g. Self-Treatment and Self-Assessment, etc. Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ActivityDefinition.useContext.code | required | KoppeltaalUsageContextType_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | |
| ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConcept | required | KoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)http://vzvz.nl/fhir/ValueSet/koppeltaal-expansionFrom this IG | |
| ActivityDefinition.topic | extensible | KoppeltaalDefinitionTopic_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topicFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ActivityDefinition | Description of an eHealth activity Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, adf-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
![]() ![]() ![]() |
1..* | Reference(KT2_Endpoint) | Endpoint to the service application URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension | |||||
![]() ![]() ![]() |
0..1 | id | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the activity definition | ||||
![]() ![]() |
ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
![]() ![]() |
Σ | 1..1 | string | Name for this activity definition (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the activity definition | |||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by pattern:code | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | Optional expansion for the activity | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Usage context type including Koppeltaal extensions Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: koppeltaal-expansion | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Closed by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The specific expansion Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Self-Treatment and Self-Assessment, etc. Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. | ||||
![]() ![]() |
0..* | BackboneElement | Who should participate in the action | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ActivityDefinition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | ||||
| ActivityDefinition.useContext.code | required | KoppeltaalUsageContextType_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | ||||
| ActivityDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextFrom the FHIR Standard | ||||
| ActivityDefinition.useContext:koppeltaal-expansion.code | required | Pattern Value: koppeltaal-expansionhttp://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-typeFrom this IG | ||||
| ActivityDefinition.useContext:koppeltaal-expansion.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextFrom the FHIR Standard | ||||
| ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConcept | required | KoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)http://vzvz.nl/fhir/ValueSet/koppeltaal-expansionFrom this IG | ||||
| ActivityDefinition.topic | extensible | KoppeltaalDefinitionTopic_VShttp://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topicFrom this IG | ||||
| ActivityDefinition.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | ||||
| ActivityDefinition.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1From the FHIR Standard | ||||
| ActivityDefinition.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-roleFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| adf-0 | warning | ActivityDefinition | 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 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ActivityDefinition | 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 | error | ActivityDefinition | 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 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ActivityDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| exp-1 | error | ActivityDefinition.dynamicValue.expression | An expression or a reference must be provided : expression.exists() or reference.exists() |
This structure is derived from ActivityDefinition
Summary
Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 34 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
The extension[endpoint] is mandatory and contains one or more references to the service application (endpoint) that provides the eHealth activity. This ensures that the activity definition is properly linked to the system(s) that can execute it.
Example:
{
"extension": [{
"url": "http://koppeltaal.nl/fhir/StructureDefinition/KT2-Endpoint",
"valueReference": {
"reference": "Endpoint/example-endpoint"
}
}]
}
The extension[publisherId] is optional and can be used to identify the publisher of the activity definition.
The topic element uses the KoppeltaalDefinitionTopic ValueSet to categorize the activity. This is particularly important for indicating patient-initiated activities.
Common topics include:
Example:
{
"topic": [{
"coding": [{
"system": "http://koppeltaal.nl/CodeSystem/definition-topic",
"code": "self-treatment"
}]
}]
}
The url element is required and should contain a unique identifier for the activity definition. This URL should be stable and globally unique.
The title element is required and should provide a human-readable name for the activity that can be displayed in user interfaces.