Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ServiceRequestActivityDefinition

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ServiceRequestActivityDefinition Version: 0.1.3
Active as of 2025-06-05 Computable Name: ServiceRequestActivityDefinition

ActivityDefinition resource which creates (templates) ServiceRequests

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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
... identifier Σ 1..* Identifier Additional identifier for the activity definition
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... Slices for subject[x] 0..1 Type of individual the activity definition is intended for
Slice: Unordered, Open by type:$this
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
.... subject[x]:subjectCodeableConcept 0..1 CodeableConcept Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Patient
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.identifier.userequiredPattern Value: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.subject[x]:subjectCodeableConceptextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.kindrequiredPattern Value: ServiceRequest
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName 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-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf 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-4errorActivityDefinitionIf 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-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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
... implicitRules 0..0
... modifierExtension 0..0
... identifier 1..* Identifier Additional identifier for the activity definition
.... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
.... value 1..1 string The value that is unique
... Slices for subject[x] 0..1 CodeableConcept, Reference(Group) Type of individual the activity definition is intended for
Slice: Unordered, Open by type:$this
.... subject[x]:subjectCodeableConcept 0..1 CodeableConcept Type of individual the activity definition is intended for
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Patient
... useContext 0..0
... copyright 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... topic 0..0
... author 0..0
... editor 0..0
... reviewer 0..0
... endorser 0..0
... relatedArtifact 0..0
... library 0..0
... kind 1..1 code Kind of resource
Required Pattern: ServiceRequest
... profile 0..0
... location 0..0
... participant
.... type 1..1 code patient | practitioner | related-person | device
Required Pattern: patient
... product[x] 0..0
... quantity 0..0
... dosage 0..0
... bodySite 0..0
... specimenRequirement 0..0
... observationRequirement 0..0
... observationResultRequirement 0..0
... transform 0..0
... dynamicValue 0..0

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
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ 1..* Identifier Additional identifier for the activity definition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... Slices for subject[x] 0..1 Type of individual the activity definition is intended for
Slice: Unordered, Open by type:$this
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
.... subject[x]:subjectCodeableConcept 0..1 CodeableConcept Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Patient
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... 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
... kind Σ 1..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Required Pattern: ServiceRequest
... 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.
... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... timing[x] 0..1 When activity is to occur
.... timingTiming Timing
.... timingDateTime dateTime
.... timingAge Age
.... timingPeriod Period
.... timingRange Range
.... timingDuration Duration
... 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.
Required Pattern: patient
.... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ActivityDefinition.identifier.userequiredPattern Value: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ActivityDefinition.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.subject[x]:subjectCodeableConceptextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ActivityDefinition.kindrequiredPattern Value: ServiceRequest
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
From the FHIR Standard
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ActivityDefinition.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
From the FHIR Standard
ActivityDefinition.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
ActivityDefinition.participant.typerequiredPattern Value: patient
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
From the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName 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-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf 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-4errorActivityDefinitionIf 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-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ActivityDefinition

Summary

Mandatory: 4 elements
Prohibited: 25 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ActivityDefinition.subject[x]

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
... identifier Σ 1..* Identifier Additional identifier for the activity definition
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... Slices for subject[x] 0..1 Type of individual the activity definition is intended for
Slice: Unordered, Open by type:$this
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
.... subject[x]:subjectCodeableConcept 0..1 CodeableConcept Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Patient
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.identifier.userequiredPattern Value: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.subject[x]:subjectCodeableConceptextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.kindrequiredPattern Value: ServiceRequest
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName 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-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf 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-4errorActivityDefinitionIf 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-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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
... implicitRules 0..0
... modifierExtension 0..0
... identifier 1..* Identifier Additional identifier for the activity definition
.... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
.... value 1..1 string The value that is unique
... Slices for subject[x] 0..1 CodeableConcept, Reference(Group) Type of individual the activity definition is intended for
Slice: Unordered, Open by type:$this
.... subject[x]:subjectCodeableConcept 0..1 CodeableConcept Type of individual the activity definition is intended for
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Patient
... useContext 0..0
... copyright 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... topic 0..0
... author 0..0
... editor 0..0
... reviewer 0..0
... endorser 0..0
... relatedArtifact 0..0
... library 0..0
... kind 1..1 code Kind of resource
Required Pattern: ServiceRequest
... profile 0..0
... location 0..0
... participant
.... type 1..1 code patient | practitioner | related-person | device
Required Pattern: patient
... product[x] 0..0
... quantity 0..0
... dosage 0..0
... bodySite 0..0
... specimenRequirement 0..0
... observationRequirement 0..0
... observationResultRequirement 0..0
... transform 0..0
... dynamicValue 0..0

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
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ 1..* Identifier Additional identifier for the activity definition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... Slices for subject[x] 0..1 Type of individual the activity definition is intended for
Slice: Unordered, Open by type:$this
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
.... subject[x]:subjectCodeableConcept 0..1 CodeableConcept Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Patient
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... 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
... kind Σ 1..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Required Pattern: ServiceRequest
... 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.
... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... timing[x] 0..1 When activity is to occur
.... timingTiming Timing
.... timingDateTime dateTime
.... timingAge Age
.... timingPeriod Period
.... timingRange Range
.... timingDuration Duration
... 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.
Required Pattern: patient
.... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ActivityDefinition.identifier.userequiredPattern Value: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ActivityDefinition.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.subject[x]:subjectCodeableConceptextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ActivityDefinition.kindrequiredPattern Value: ServiceRequest
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
From the FHIR Standard
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ActivityDefinition.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
From the FHIR Standard
ActivityDefinition.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
ActivityDefinition.participant.typerequiredPattern Value: patient
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
From the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName 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-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf 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-4errorActivityDefinitionIf 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-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ActivityDefinition

Summary

Mandatory: 4 elements
Prohibited: 25 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ActivityDefinition.subject[x]

 

Other representations of profile: CSV, Excel, Schematron