HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - STU1 International flag

HL7 FHIR Implementation Guide: Rwanda HIV, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/openhie/Rwanda-HIV and changes regularly. See the Directory of published versions

Resource Profile: HIV Lab Order Activity Definition

Official URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/hiv-lab-task-activity Version: 0.1.0
Active as of 2023-09-15 Computable Name: LabOrderTaskActivity

Represents more specific information regarding the task’s lab order request.

Usage:

Formal Views of Profile Content

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

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... RevisedBy S0..1integerHIV Viral Load Result Revised By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/revised-by-user-index
... date S0..1dateTimeDate last changed
... lastReviewDate S0..1dateWhen the activity definition was last reviewed by the publisher
... editor S0..*ContactDetailWho edited the content
.... name S0..1stringName of an individual to contact
... reviewer S0..*ContactDetailWho reviewed the content
.... LabTaskReviewer S0..1integerHIV Lab Task Reviewed By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-reviewed-by-user-index
.... name S0..1stringName of an individual to contact
... endorser S0..*ContactDetailWho endorsed the content
.... LabTaskApprovedBy S0..1integerHIV Lab Task Approved By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-approved-by-user-index
.... name S0..1stringName of an individual to contact
... specimenRequirement S0..*canonical(SpecimenDefinition)What specimens are required to perform this action

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ0..1dateTimeDate last changed
... approvalDate S0..1dateWhen the activity definition was approved by publisher
... lastReviewDate S0..1dateWhen the activity definition was last reviewed by the publisher
... editor S0..*ContactDetailWho edited the content
.... name SΣ0..1stringName of an individual to contact
... reviewer S0..*ContactDetailWho reviewed the content
.... LabTaskReviewer S0..1integerHIV Lab Task Reviewed By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-reviewed-by-user-index
.... name SΣ0..1stringName of an individual to contact
... endorser S0..*ContactDetailWho endorsed the content
.... LabTaskApprovedBy S0..1integerHIV Lab Task Approved By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-approved-by-user-index
.... name SΣ0..1stringName of an individual to contact
... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... specimenRequirement S0..*canonical(SpecimenDefinition)What specimens are required to perform this action

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ActivityDefinition.statusrequiredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... RevisedBy S0..1integerHIV Viral Load Result Revised By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/revised-by-user-index
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ0..1stringBusiness version of the activity definition
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this activity definition (computer friendly)
... title Σ0..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date SΣ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1markdownDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate S0..1dateWhen the activity definition was approved by publisher
... lastReviewDate S0..1dateWhen the activity definition was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... name SΣ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or organization
... reviewer S0..*ContactDetailWho reviewed the content
.... id 0..1idUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... LabTaskReviewer S0..1integerHIV Lab Task Reviewed By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-reviewed-by-user-index
.... name SΣ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or organization
... endorser S0..*ContactDetailWho endorsed the content
.... id 0..1idUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... LabTaskApprovedBy S0..1integerHIV Lab Task Approved By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-approved-by-user-index
.... name SΣ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or organization
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... library 0..*canonical(Library)Logic used by the activity definition
... kind Σ0..1codeKind of resource
Binding: RequestResourceTypes (required): The kind of activity the definition is describing.

... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code Σ0..1CodeableConceptDetail type of activity
Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.

... intent 0..1codeproposal | 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..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingAgeAge
.... timingRangeRange
.... timingDurationDuration
... asNeeded[x] Σ0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... location 0..1CodeableReference(Location)Where it should happen
... participant 0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

.... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
.... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: Action Participant Role (example): Defines roles played by participants for the action.

.... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
... product[x] 0..1What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.

.... productReferenceReference(Medication | Ingredient | Substance | SubstanceDefinition)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.


... specimenRequirement S0..*canonical(SpecimenDefinition)What specimens are required to perform this action
... observationRequirement 0..*canonical(ObservationDefinition)What observations are required to perform this action
... observationResultRequirement 0..*canonical(ObservationDefinition)What observations must be produced by this action
... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 1..1stringThe path to the element to be set dynamically
.... expression 1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ActivityDefinition.languagerequiredAllLanguages
ActivityDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.subject[x]extensibleParticipantResourceTypes
ActivityDefinition.jurisdictionextensibleJurisdictionValueSet
ActivityDefinition.topicexampleDefinitionTopic
ActivityDefinition.kindrequiredRequestResourceTypes
ActivityDefinition.codeexampleProcedureCodesSNOMEDCT
ActivityDefinition.intentrequiredRequestIntent
ActivityDefinition.priorityrequiredRequestPriority
ActivityDefinition.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ActivityDefinition.participant.typerequiredActionParticipantType
ActivityDefinition.participant.roleexampleActionParticipantRole
ActivityDefinition.participant.functionexampleActionParticipantFunction
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningActivityDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 & Constraintsdoco
.. ActivityDefinition 0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... RevisedBy S0..1integerHIV Viral Load Result Revised By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/revised-by-user-index
... date S0..1dateTimeDate last changed
... lastReviewDate S0..1dateWhen the activity definition was last reviewed by the publisher
... editor S0..*ContactDetailWho edited the content
.... name S0..1stringName of an individual to contact
... reviewer S0..*ContactDetailWho reviewed the content
.... LabTaskReviewer S0..1integerHIV Lab Task Reviewed By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-reviewed-by-user-index
.... name S0..1stringName of an individual to contact
... endorser S0..*ContactDetailWho endorsed the content
.... LabTaskApprovedBy S0..1integerHIV Lab Task Approved By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-approved-by-user-index
.... name S0..1stringName of an individual to contact
... specimenRequirement S0..*canonical(SpecimenDefinition)What specimens are required to perform this action

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ0..1dateTimeDate last changed
... approvalDate S0..1dateWhen the activity definition was approved by publisher
... lastReviewDate S0..1dateWhen the activity definition was last reviewed by the publisher
... editor S0..*ContactDetailWho edited the content
.... name SΣ0..1stringName of an individual to contact
... reviewer S0..*ContactDetailWho reviewed the content
.... LabTaskReviewer S0..1integerHIV Lab Task Reviewed By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-reviewed-by-user-index
.... name SΣ0..1stringName of an individual to contact
... endorser S0..*ContactDetailWho endorsed the content
.... LabTaskApprovedBy S0..1integerHIV Lab Task Approved By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-approved-by-user-index
.... name SΣ0..1stringName of an individual to contact
... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... specimenRequirement S0..*canonical(SpecimenDefinition)What specimens are required to perform this action

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ActivityDefinition.statusrequiredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... RevisedBy S0..1integerHIV Viral Load Result Revised By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/revised-by-user-index
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ0..1stringBusiness version of the activity definition
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this activity definition (computer friendly)
... title Σ0..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date SΣ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1markdownDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate S0..1dateWhen the activity definition was approved by publisher
... lastReviewDate S0..1dateWhen the activity definition was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... name SΣ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or organization
... reviewer S0..*ContactDetailWho reviewed the content
.... id 0..1idUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... LabTaskReviewer S0..1integerHIV Lab Task Reviewed By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-reviewed-by-user-index
.... name SΣ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or organization
... endorser S0..*ContactDetailWho endorsed the content
.... id 0..1idUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... LabTaskApprovedBy S0..1integerHIV Lab Task Approved By
URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/task-approved-by-user-index
.... name SΣ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or organization
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... library 0..*canonical(Library)Logic used by the activity definition
... kind Σ0..1codeKind of resource
Binding: RequestResourceTypes (required): The kind of activity the definition is describing.

... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code Σ0..1CodeableConceptDetail type of activity
Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.

... intent 0..1codeproposal | 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..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingAgeAge
.... timingRangeRange
.... timingDurationDuration
... asNeeded[x] Σ0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... location 0..1CodeableReference(Location)Where it should happen
... participant 0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

.... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
.... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: Action Participant Role (example): Defines roles played by participants for the action.

.... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
... product[x] 0..1What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.

.... productReferenceReference(Medication | Ingredient | Substance | SubstanceDefinition)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.


... specimenRequirement S0..*canonical(SpecimenDefinition)What specimens are required to perform this action
... observationRequirement 0..*canonical(ObservationDefinition)What observations are required to perform this action
... observationResultRequirement 0..*canonical(ObservationDefinition)What observations must be produced by this action
... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 1..1stringThe path to the element to be set dynamically
.... expression 1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ActivityDefinition.languagerequiredAllLanguages
ActivityDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.subject[x]extensibleParticipantResourceTypes
ActivityDefinition.jurisdictionextensibleJurisdictionValueSet
ActivityDefinition.topicexampleDefinitionTopic
ActivityDefinition.kindrequiredRequestResourceTypes
ActivityDefinition.codeexampleProcedureCodesSNOMEDCT
ActivityDefinition.intentrequiredRequestIntent
ActivityDefinition.priorityrequiredRequestPriority
ActivityDefinition.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ActivityDefinition.participant.typerequiredActionParticipantType
ActivityDefinition.participant.roleexampleActionParticipantRole
ActivityDefinition.participant.functionexampleActionParticipantFunction
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningActivityDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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()

 

Other representations of profile: CSV, Excel, Schematron