HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide
0.1.0 - CI Build
HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide, published by Te Aho o Te Kahu, Cancer Control Agency. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/cca/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.nz/fhir/StructureDefinition/CcaActivityDefinition | Version: 0.1.0 | |||
Active as of 2024-03-03 | Realm: | Computable Name: CcaActivityDefinition |
CCA Regimen Activity Definition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ActivityDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
location-medication-collection | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection Binding: Medication collection location (required) | |
location-administration | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site Binding: Administration location (required) | |
off-label | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |
identifier | 0..0 | |||
experimental | 0..0 | |||
subject[x] | 0..0 | |||
useContext | 0..0 | |||
approvalDate | 0..0 | |||
lastReviewDate | 0..0 | |||
topic | 0..0 | |||
author | 0..0 | |||
editor | 0..0 | |||
reviewer | 0..0 | |||
library | 0..0 | |||
priority | 0..0 | |||
doNotPerform | 0..0 | |||
timing[x] | 0..0 | |||
specimenRequirement | 0..0 | |||
observationRequirement | 0..0 | |||
observationResultRequirement | 0..0 | |||
transform | 0..0 | |||
dynamicValue | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
location-medication-collection | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection Binding: Medication collection location (required) | |
location-administration | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site Binding: Administration location (required) | |
off-label | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
location-medication-collection | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection Binding: Medication collection location (required) | |||||
location-administration | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site Binding: Administration location (required) | |||||
off-label | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
version | Σ | 0..1 | string | Business version of the activity definition | ||||
name | ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
title | Σ | 0..1 | string | Name for this activity definition (human friendly) | ||||
subtitle | 0..1 | string | Subordinate title of the activity definition | |||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this activity definition is defined | |||||
usage | 0..1 | string | Describes the clinical usage of the activity definition | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
effectivePeriod | Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
endorser | 0..* | ContactDetail | Who endorsed the content | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
kind | Σ | 0..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. | ||||
profile | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |||||
code | Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. | ||||
intent | 0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | |||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
participant | 0..* | BackboneElement | Who should participate in the action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
product[x] | 0..1 | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||||||
productReference | Reference(Medication | Substance) | |||||||
productCodeableConcept | CodeableConcept | |||||||
quantity | 0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
dosage | 0..* | Dosage | Detailed dosage instructions | |||||
bodySite | 0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location. | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ActivityDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
ActivityDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
ActivityDefinition.kind | required | RequestResourceTypehttp://hl7.org/fhir/ValueSet/request-resource-types|4.0.1 from the FHIR Standard | ||||
ActivityDefinition.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
ActivityDefinition.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ActivityDefinition.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1 from the FHIR Standard | ||||
ActivityDefinition.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-role from the FHIR Standard | ||||
ActivityDefinition.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
ActivityDefinition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
This structure is derived from ActivityDefinition
Differential View
This structure is derived from ActivityDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
location-medication-collection | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection Binding: Medication collection location (required) | |
location-administration | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site Binding: Administration location (required) | |
off-label | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |
identifier | 0..0 | |||
experimental | 0..0 | |||
subject[x] | 0..0 | |||
useContext | 0..0 | |||
approvalDate | 0..0 | |||
lastReviewDate | 0..0 | |||
topic | 0..0 | |||
author | 0..0 | |||
editor | 0..0 | |||
reviewer | 0..0 | |||
library | 0..0 | |||
priority | 0..0 | |||
doNotPerform | 0..0 | |||
timing[x] | 0..0 | |||
specimenRequirement | 0..0 | |||
observationRequirement | 0..0 | |||
observationResultRequirement | 0..0 | |||
transform | 0..0 | |||
dynamicValue | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
location-medication-collection | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection Binding: Medication collection location (required) | |
location-administration | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site Binding: Administration location (required) | |
off-label | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
location-medication-collection | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection Binding: Medication collection location (required) | |||||
location-administration | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site Binding: Administration location (required) | |||||
off-label | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
version | Σ | 0..1 | string | Business version of the activity definition | ||||
name | ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
title | Σ | 0..1 | string | Name for this activity definition (human friendly) | ||||
subtitle | 0..1 | string | Subordinate title of the activity definition | |||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this activity definition is defined | |||||
usage | 0..1 | string | Describes the clinical usage of the activity definition | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
effectivePeriod | Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
endorser | 0..* | ContactDetail | Who endorsed the content | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
kind | Σ | 0..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. | ||||
profile | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |||||
code | Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. | ||||
intent | 0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | |||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
participant | 0..* | BackboneElement | Who should participate in the action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
product[x] | 0..1 | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||||||
productReference | Reference(Medication | Substance) | |||||||
productCodeableConcept | CodeableConcept | |||||||
quantity | 0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
dosage | 0..* | Dosage | Detailed dosage instructions | |||||
bodySite | 0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location. | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ActivityDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
ActivityDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
ActivityDefinition.kind | required | RequestResourceTypehttp://hl7.org/fhir/ValueSet/request-resource-types|4.0.1 from the FHIR Standard | ||||
ActivityDefinition.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
ActivityDefinition.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ActivityDefinition.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1 from the FHIR Standard | ||||
ActivityDefinition.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-role from the FHIR Standard | ||||
ActivityDefinition.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
ActivityDefinition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
This structure is derived from ActivityDefinition
Other representations of profile: CSV, Excel, Schematron