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

Resource Profile: ActivityDefinition

Official URL: http://hl7.org.nz/fhir/StructureDefinition/CcaActivityDefinition Version: 0.1.0
Active as of 2026-05-21 Computable Name: CcaActivityDefinition

CCA Regimen Activity Definition.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... 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
.... extension:location-medication-collection 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection
Binding: Medication collection location (required)
.... extension:location-administration 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site
Binding: Administration location (required)
.... extension: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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... extension:location-medication-collection 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection
Binding: Medication collection location (required)
.... extension:location-administration 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site
Binding: Administration location (required)
.... extension:off-label 0..1 boolean Off label
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label
... identifier 0..0 Additional identifier for the activity definition
... experimental 0..0 For testing purposes, not real usage
... useContext 0..0 The context that the content is intended to support
... approvalDate 0..0 When the activity definition was approved by publisher
... lastReviewDate 0..0 When the activity definition was last reviewed
... topic 0..0 E.g. Education, Treatment, Assessment, etc.
... author 0..0 Who authored the content
... editor 0..0 Who edited the content
... reviewer 0..0 Who reviewed the content
... library 0..0 Logic used by the activity definition
... priority 0..0 routine | urgent | asap | stat
... doNotPerform 0..0 True if the activity should not be performed
... timing[x] 0..0 When activity is to occur
... specimenRequirement 0..0 What specimens are required to perform this action
... observationRequirement 0..0 What observations are required to perform this action
... observationResultRequirement 0..0 What observations must be produced by this action
... transform 0..0 Transform to apply the template
... dynamicValue 0..0 Dynamic aspects of the definition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:location-medication-collection 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection
Binding: Medication collection location (required)
.... extension:location-administration 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site
Binding: Administration location (required)
.... extension: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(4.0.1) 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.
ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... 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
.... extension:location-medication-collection 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection
Binding: Medication collection location (required)
.... extension:location-administration 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site
Binding: Administration location (required)
.... extension: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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... extension:location-medication-collection 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection
Binding: Medication collection location (required)
.... extension:location-administration 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site
Binding: Administration location (required)
.... extension:off-label 0..1 boolean Off label
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label
... identifier 0..0 Additional identifier for the activity definition
... experimental 0..0 For testing purposes, not real usage
... useContext 0..0 The context that the content is intended to support
... approvalDate 0..0 When the activity definition was approved by publisher
... lastReviewDate 0..0 When the activity definition was last reviewed
... topic 0..0 E.g. Education, Treatment, Assessment, etc.
... author 0..0 Who authored the content
... editor 0..0 Who edited the content
... reviewer 0..0 Who reviewed the content
... library 0..0 Logic used by the activity definition
... priority 0..0 routine | urgent | asap | stat
... doNotPerform 0..0 True if the activity should not be performed
... timing[x] 0..0 When activity is to occur
... specimenRequirement 0..0 What specimens are required to perform this action
... observationRequirement 0..0 What observations are required to perform this action
... observationResultRequirement 0..0 What observations must be produced by this action
... transform 0..0 Transform to apply the template
... dynamicValue 0..0 Dynamic aspects of the definition

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:location-medication-collection 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection
Binding: Medication collection location (required)
.... extension:location-administration 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site
Binding: Administration location (required)
.... extension: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(4.0.1) 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.
ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

 

Other representations of profile: CSV, Excel, Schematron