Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_ActivityDefinition_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-ActivityDefinition Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_ActivityDefinition_R4

This cross-version profile allows R5 ActivityDefinition content to be represented via FHIR R4 ActivityDefinition resources.

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(4.0.1) 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
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:subject 0..1 canonical(Cross-version Profile for R5.EvidenceVariable for use in FHIR R4(0.1.0) | EvidenceVariable) R5: subject additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subject
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:asNeeded 0..1 boolean, CodeableConcept R5: Preconditions for service (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.asNeeded
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed

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 ActivityDefinition.implicitRules, ActivityDefinition.extension, ActivityDefinition.extension:versionAlgorithm, ActivityDefinition.extension:subject, ActivityDefinition.extension:copyrightLabel, ActivityDefinition.extension:asNeeded, ActivityDefinition.modifierExtension, ActivityDefinition.status, ActivityDefinition.doNotPerform All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ActivityDefinition.extension, ActivityDefinition.extension:versionAlgorithm, ActivityDefinition.extension:subject, ActivityDefinition.extension:copyrightLabel, ActivityDefinition.extension:asNeeded, ActivityDefinition.modifierExtension 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(4.0.1) 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:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:subject 0..1 canonical(Cross-version Profile for R5.EvidenceVariable for use in FHIR R4(0.1.0) | EvidenceVariable) R5: subject additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subject
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:asNeeded 0..1 boolean, CodeableConcept R5: Preconditions for service (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.asNeeded
... subjectReference
.... Slices for extension Content/Rules for all slices
..... extension:alternateReference 0..1 Reference(Resource) R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... kind
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:kind 0..1 code R5: kind
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.kind
Binding: RequestResourceType (required): The kind of activity the definition is describing.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 CodeableConcept R5: location additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.location
... participant
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:typeCanonical 0..1 canonical(Cross-version Profile for R5.CapabilityStatement for use in FHIR R4(0.1.0) | CapabilityStatement) R5: Who or what can participate (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeCanonical
..... extension:typeReference 0..1 Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR R4(0.1.0) | DeviceDefinition | Cross-version Profile for R5.Endpoint for use in FHIR R4(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson) R5: Who or what can participate (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeReference
..... extension:function 0..1 CodeableConcept R5: E.g. Author, Reviewer, Witness, etc (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.function
Binding: R5ActionParticipantFunctionForR4 (0.1.0) (example)
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.type
Binding: R5ActionParticipantTypeForR4 (0.1.0) (required): The type of participant in the activity.
... productReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:alternateReference 0..1 Reference(Resource) R5: product
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... specimenRequirement
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:specimenRequirement 0..* canonical(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4(0.1.0) | SpecimenDefinition) R5: specimenRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.specimenRequirement
... observationRequirement
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:observationRequirement 0..* canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) R5: observationRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationRequirement
... observationResultRequirement
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:observationResultRequirement 0..* canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) R5: observationResultRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationResultRequirement

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition(4.0.1) 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
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:subject 0..1 canonical(Cross-version Profile for R5.EvidenceVariable for use in FHIR R4(0.1.0) | EvidenceVariable) R5: subject additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subject
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:asNeeded 0..1 boolean, CodeableConcept R5: Preconditions for service (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.asNeeded
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the activity definition
... 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
... subject[x] 0..1 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.).
.... subject[x]All Types Content/Rules for all Types
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:alternateReference 0..1 Reference(Resource) R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... 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
... useContext Σ 0..* UsageContext The context that the content is intended to support
... 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
... approvalDate 0..1 date When the activity definition was approved by publisher
... lastReviewDate 0..1 date When the activity definition was last reviewed
... effectivePeriod Σ 0..1 Period When the activity definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... library 0..* canonical(Library) Logic used by the activity definition
... kind Σ 0..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:kind 0..1 code R5: kind
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.kind
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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.
... 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
... location 0..1 Reference(Location) Where it should happen
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:location 0..1 CodeableConcept R5: location additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.location
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... participant 0..* BackboneElement Who should participate in the action
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:typeCanonical 0..1 canonical(Cross-version Profile for R5.CapabilityStatement for use in FHIR R4(0.1.0) | CapabilityStatement) R5: Who or what can participate (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeCanonical
Constraints: ext-1
..... extension:typeReference 0..1 Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR R4(0.1.0) | DeviceDefinition | Cross-version Profile for R5.Endpoint for use in FHIR R4(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson) R5: Who or what can participate (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeReference
Constraints: ext-1
..... extension:function 0..1 CodeableConcept R5: E.g. Author, Reviewer, Witness, etc (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.function
Binding: R5ActionParticipantFunctionForR4 (0.1.0) (example)
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType . (required): The type of participant in the activity.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.type
Binding: R5ActionParticipantTypeForR4 (0.1.0) (required): The type of participant in the activity.
Constraints: ext-1
..... value 0..1 string Primitive value for code
.... 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.
.... product[x]All Types Content/Rules for all Types
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:alternateReference 0..1 Reference(Resource) R5: product
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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.
... specimenRequirement 0..* Reference(SpecimenDefinition) What specimens are required to perform this action
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:specimenRequirement 0..* canonical(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4(0.1.0) | SpecimenDefinition) R5: specimenRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.specimenRequirement
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... observationRequirement 0..* Reference(ObservationDefinition) What observations are required to perform this action
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:observationRequirement 0..* canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) R5: observationRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationRequirement
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... observationResultRequirement 0..* Reference(ObservationDefinition) What observations must be produced by this action
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:observationResultRequirement 0..* canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) R5: observationResultRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationResultRequirement
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... transform 0..1 canonical(StructureMap) Transform to apply the template
... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... path 1..1 string The path to the element to be set dynamically
.... expression 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.topic Base example DefinitionTopic 📍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.priority Base required Request priority 📍4.0.1 FHIR Std.
ActivityDefinition.location.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
ActivityDefinition.participant.​type Base required ActionParticipantType . 📍4.0.1 tx.fhir.org
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.
ActivityDefinition.specimenRequirement.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
ActivityDefinition.observationRequirement.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
ActivityDefinition.observationResultRequirement.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org

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 ActivityDefinition.meta, ActivityDefinition.implicitRules, ActivityDefinition.language, ActivityDefinition.text, ActivityDefinition.extension, ActivityDefinition.extension:versionAlgorithm, ActivityDefinition.extension:subject, ActivityDefinition.extension:copyrightLabel, ActivityDefinition.extension:asNeeded, ActivityDefinition.modifierExtension, ActivityDefinition.url, ActivityDefinition.identifier, ActivityDefinition.version, ActivityDefinition.name, ActivityDefinition.title, ActivityDefinition.subtitle, ActivityDefinition.status, ActivityDefinition.experimental, ActivityDefinition.subject[x], ActivityDefinition.subject[x].extension, ActivityDefinition.subject[x].extension:alternateReference, ActivityDefinition.date, ActivityDefinition.publisher, ActivityDefinition.contact, ActivityDefinition.description, ActivityDefinition.useContext, ActivityDefinition.jurisdiction, ActivityDefinition.purpose, ActivityDefinition.usage, ActivityDefinition.copyright, ActivityDefinition.approvalDate, ActivityDefinition.lastReviewDate, ActivityDefinition.effectivePeriod, ActivityDefinition.topic, ActivityDefinition.author, ActivityDefinition.editor, ActivityDefinition.reviewer, ActivityDefinition.endorser, ActivityDefinition.relatedArtifact, ActivityDefinition.library, ActivityDefinition.kind, ActivityDefinition.kind.extension, ActivityDefinition.kind.extension:kind, ActivityDefinition.profile, ActivityDefinition.code, ActivityDefinition.intent, ActivityDefinition.priority, ActivityDefinition.doNotPerform, ActivityDefinition.timing[x], ActivityDefinition.location, ActivityDefinition.location.extension, ActivityDefinition.location.extension:location, ActivityDefinition.location.reference, ActivityDefinition.location.type, ActivityDefinition.location.identifier, ActivityDefinition.location.display, ActivityDefinition.participant, ActivityDefinition.participant.extension, ActivityDefinition.participant.extension:typeCanonical, ActivityDefinition.participant.extension:typeReference, ActivityDefinition.participant.extension:function, ActivityDefinition.participant.modifierExtension, ActivityDefinition.participant.type, ActivityDefinition.participant.type.extension, ActivityDefinition.participant.type.extension:type, ActivityDefinition.participant.role, ActivityDefinition.product[x], ActivityDefinition.product[x].extension, ActivityDefinition.product[x].extension:alternateReference, ActivityDefinition.quantity, ActivityDefinition.dosage, ActivityDefinition.bodySite, ActivityDefinition.specimenRequirement, ActivityDefinition.specimenRequirement.extension, ActivityDefinition.specimenRequirement.extension:specimenRequirement, ActivityDefinition.specimenRequirement.reference, ActivityDefinition.specimenRequirement.type, ActivityDefinition.specimenRequirement.identifier, ActivityDefinition.specimenRequirement.display, ActivityDefinition.observationRequirement, ActivityDefinition.observationRequirement.extension, ActivityDefinition.observationRequirement.extension:observationRequirement, ActivityDefinition.observationRequirement.reference, ActivityDefinition.observationRequirement.type, ActivityDefinition.observationRequirement.identifier, ActivityDefinition.observationRequirement.display, ActivityDefinition.observationResultRequirement, ActivityDefinition.observationResultRequirement.extension, ActivityDefinition.observationResultRequirement.extension:observationResultRequirement, ActivityDefinition.observationResultRequirement.reference, ActivityDefinition.observationResultRequirement.type, ActivityDefinition.observationResultRequirement.identifier, ActivityDefinition.observationResultRequirement.display, ActivityDefinition.transform, ActivityDefinition.dynamicValue, ActivityDefinition.dynamicValue.extension, ActivityDefinition.dynamicValue.modifierExtension, ActivityDefinition.dynamicValue.path, ActivityDefinition.dynamicValue.expression All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ActivityDefinition.extension, ActivityDefinition.extension:versionAlgorithm, ActivityDefinition.extension:subject, ActivityDefinition.extension:copyrightLabel, ActivityDefinition.extension:asNeeded, ActivityDefinition.modifierExtension, ActivityDefinition.subject[x].extension, ActivityDefinition.subject[x].extension:alternateReference, ActivityDefinition.kind.extension, ActivityDefinition.kind.extension:kind, ActivityDefinition.location.extension, ActivityDefinition.location.extension:location, ActivityDefinition.participant.extension, ActivityDefinition.participant.extension:typeCanonical, ActivityDefinition.participant.extension:typeReference, ActivityDefinition.participant.extension:function, ActivityDefinition.participant.modifierExtension, ActivityDefinition.participant.type.extension, ActivityDefinition.participant.type.extension:type, ActivityDefinition.product[x].extension, ActivityDefinition.product[x].extension:alternateReference, ActivityDefinition.specimenRequirement.extension, ActivityDefinition.specimenRequirement.extension:specimenRequirement, ActivityDefinition.observationRequirement.extension, ActivityDefinition.observationRequirement.extension:observationRequirement, ActivityDefinition.observationResultRequirement.extension, ActivityDefinition.observationResultRequirement.extension:observationResultRequirement, ActivityDefinition.dynamicValue.extension, ActivityDefinition.dynamicValue.modifierExtension 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(4.0.1) 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
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:subject 0..1 canonical(Cross-version Profile for R5.EvidenceVariable for use in FHIR R4(0.1.0) | EvidenceVariable) R5: subject additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subject
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:asNeeded 0..1 boolean, CodeableConcept R5: Preconditions for service (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.asNeeded
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed

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 ActivityDefinition.implicitRules, ActivityDefinition.extension, ActivityDefinition.extension:versionAlgorithm, ActivityDefinition.extension:subject, ActivityDefinition.extension:copyrightLabel, ActivityDefinition.extension:asNeeded, ActivityDefinition.modifierExtension, ActivityDefinition.status, ActivityDefinition.doNotPerform All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ActivityDefinition.extension, ActivityDefinition.extension:versionAlgorithm, ActivityDefinition.extension:subject, ActivityDefinition.extension:copyrightLabel, ActivityDefinition.extension:asNeeded, ActivityDefinition.modifierExtension 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(4.0.1) 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:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:subject 0..1 canonical(Cross-version Profile for R5.EvidenceVariable for use in FHIR R4(0.1.0) | EvidenceVariable) R5: subject additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subject
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:asNeeded 0..1 boolean, CodeableConcept R5: Preconditions for service (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.asNeeded
... subjectReference
.... Slices for extension Content/Rules for all slices
..... extension:alternateReference 0..1 Reference(Resource) R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... kind
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:kind 0..1 code R5: kind
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.kind
Binding: RequestResourceType (required): The kind of activity the definition is describing.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 CodeableConcept R5: location additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.location
... participant
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:typeCanonical 0..1 canonical(Cross-version Profile for R5.CapabilityStatement for use in FHIR R4(0.1.0) | CapabilityStatement) R5: Who or what can participate (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeCanonical
..... extension:typeReference 0..1 Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR R4(0.1.0) | DeviceDefinition | Cross-version Profile for R5.Endpoint for use in FHIR R4(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson) R5: Who or what can participate (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeReference
..... extension:function 0..1 CodeableConcept R5: E.g. Author, Reviewer, Witness, etc (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.function
Binding: R5ActionParticipantFunctionForR4 (0.1.0) (example)
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.type
Binding: R5ActionParticipantTypeForR4 (0.1.0) (required): The type of participant in the activity.
... productReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:alternateReference 0..1 Reference(Resource) R5: product
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... specimenRequirement
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:specimenRequirement 0..* canonical(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4(0.1.0) | SpecimenDefinition) R5: specimenRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.specimenRequirement
... observationRequirement
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:observationRequirement 0..* canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) R5: observationRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationRequirement
... observationResultRequirement
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:observationResultRequirement 0..* canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) R5: observationResultRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationResultRequirement

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition(4.0.1) 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
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:subject 0..1 canonical(Cross-version Profile for R5.EvidenceVariable for use in FHIR R4(0.1.0) | EvidenceVariable) R5: subject additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subject
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:asNeeded 0..1 boolean, CodeableConcept R5: Preconditions for service (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.asNeeded
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the activity definition
... 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
... subject[x] 0..1 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.).
.... subject[x]All Types Content/Rules for all Types
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:alternateReference 0..1 Reference(Resource) R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... 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
... useContext Σ 0..* UsageContext The context that the content is intended to support
... 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
... approvalDate 0..1 date When the activity definition was approved by publisher
... lastReviewDate 0..1 date When the activity definition was last reviewed
... effectivePeriod Σ 0..1 Period When the activity definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... library 0..* canonical(Library) Logic used by the activity definition
... kind Σ 0..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:kind 0..1 code R5: kind
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.kind
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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.
... 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
... location 0..1 Reference(Location) Where it should happen
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:location 0..1 CodeableConcept R5: location additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.location
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... participant 0..* BackboneElement Who should participate in the action
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:typeCanonical 0..1 canonical(Cross-version Profile for R5.CapabilityStatement for use in FHIR R4(0.1.0) | CapabilityStatement) R5: Who or what can participate (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeCanonical
Constraints: ext-1
..... extension:typeReference 0..1 Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR R4(0.1.0) | DeviceDefinition | Cross-version Profile for R5.Endpoint for use in FHIR R4(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson) R5: Who or what can participate (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeReference
Constraints: ext-1
..... extension:function 0..1 CodeableConcept R5: E.g. Author, Reviewer, Witness, etc (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.function
Binding: R5ActionParticipantFunctionForR4 (0.1.0) (example)
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType . (required): The type of participant in the activity.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.type
Binding: R5ActionParticipantTypeForR4 (0.1.0) (required): The type of participant in the activity.
Constraints: ext-1
..... value 0..1 string Primitive value for code
.... 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.
.... product[x]All Types Content/Rules for all Types
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:alternateReference 0..1 Reference(Resource) R5: product
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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.
... specimenRequirement 0..* Reference(SpecimenDefinition) What specimens are required to perform this action
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:specimenRequirement 0..* canonical(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4(0.1.0) | SpecimenDefinition) R5: specimenRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.specimenRequirement
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... observationRequirement 0..* Reference(ObservationDefinition) What observations are required to perform this action
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:observationRequirement 0..* canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) R5: observationRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationRequirement
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... observationResultRequirement 0..* Reference(ObservationDefinition) What observations must be produced by this action
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:observationResultRequirement 0..* canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) R5: observationResultRequirement additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationResultRequirement
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... transform 0..1 canonical(StructureMap) Transform to apply the template
... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... path 1..1 string The path to the element to be set dynamically
.... expression 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.topic Base example DefinitionTopic 📍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.priority Base required Request priority 📍4.0.1 FHIR Std.
ActivityDefinition.location.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
ActivityDefinition.participant.​type Base required ActionParticipantType . 📍4.0.1 tx.fhir.org
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.
ActivityDefinition.specimenRequirement.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
ActivityDefinition.observationRequirement.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
ActivityDefinition.observationResultRequirement.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org

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 ActivityDefinition.meta, ActivityDefinition.implicitRules, ActivityDefinition.language, ActivityDefinition.text, ActivityDefinition.extension, ActivityDefinition.extension:versionAlgorithm, ActivityDefinition.extension:subject, ActivityDefinition.extension:copyrightLabel, ActivityDefinition.extension:asNeeded, ActivityDefinition.modifierExtension, ActivityDefinition.url, ActivityDefinition.identifier, ActivityDefinition.version, ActivityDefinition.name, ActivityDefinition.title, ActivityDefinition.subtitle, ActivityDefinition.status, ActivityDefinition.experimental, ActivityDefinition.subject[x], ActivityDefinition.subject[x].extension, ActivityDefinition.subject[x].extension:alternateReference, ActivityDefinition.date, ActivityDefinition.publisher, ActivityDefinition.contact, ActivityDefinition.description, ActivityDefinition.useContext, ActivityDefinition.jurisdiction, ActivityDefinition.purpose, ActivityDefinition.usage, ActivityDefinition.copyright, ActivityDefinition.approvalDate, ActivityDefinition.lastReviewDate, ActivityDefinition.effectivePeriod, ActivityDefinition.topic, ActivityDefinition.author, ActivityDefinition.editor, ActivityDefinition.reviewer, ActivityDefinition.endorser, ActivityDefinition.relatedArtifact, ActivityDefinition.library, ActivityDefinition.kind, ActivityDefinition.kind.extension, ActivityDefinition.kind.extension:kind, ActivityDefinition.profile, ActivityDefinition.code, ActivityDefinition.intent, ActivityDefinition.priority, ActivityDefinition.doNotPerform, ActivityDefinition.timing[x], ActivityDefinition.location, ActivityDefinition.location.extension, ActivityDefinition.location.extension:location, ActivityDefinition.location.reference, ActivityDefinition.location.type, ActivityDefinition.location.identifier, ActivityDefinition.location.display, ActivityDefinition.participant, ActivityDefinition.participant.extension, ActivityDefinition.participant.extension:typeCanonical, ActivityDefinition.participant.extension:typeReference, ActivityDefinition.participant.extension:function, ActivityDefinition.participant.modifierExtension, ActivityDefinition.participant.type, ActivityDefinition.participant.type.extension, ActivityDefinition.participant.type.extension:type, ActivityDefinition.participant.role, ActivityDefinition.product[x], ActivityDefinition.product[x].extension, ActivityDefinition.product[x].extension:alternateReference, ActivityDefinition.quantity, ActivityDefinition.dosage, ActivityDefinition.bodySite, ActivityDefinition.specimenRequirement, ActivityDefinition.specimenRequirement.extension, ActivityDefinition.specimenRequirement.extension:specimenRequirement, ActivityDefinition.specimenRequirement.reference, ActivityDefinition.specimenRequirement.type, ActivityDefinition.specimenRequirement.identifier, ActivityDefinition.specimenRequirement.display, ActivityDefinition.observationRequirement, ActivityDefinition.observationRequirement.extension, ActivityDefinition.observationRequirement.extension:observationRequirement, ActivityDefinition.observationRequirement.reference, ActivityDefinition.observationRequirement.type, ActivityDefinition.observationRequirement.identifier, ActivityDefinition.observationRequirement.display, ActivityDefinition.observationResultRequirement, ActivityDefinition.observationResultRequirement.extension, ActivityDefinition.observationResultRequirement.extension:observationResultRequirement, ActivityDefinition.observationResultRequirement.reference, ActivityDefinition.observationResultRequirement.type, ActivityDefinition.observationResultRequirement.identifier, ActivityDefinition.observationResultRequirement.display, ActivityDefinition.transform, ActivityDefinition.dynamicValue, ActivityDefinition.dynamicValue.extension, ActivityDefinition.dynamicValue.modifierExtension, ActivityDefinition.dynamicValue.path, ActivityDefinition.dynamicValue.expression All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ActivityDefinition.extension, ActivityDefinition.extension:versionAlgorithm, ActivityDefinition.extension:subject, ActivityDefinition.extension:copyrightLabel, ActivityDefinition.extension:asNeeded, ActivityDefinition.modifierExtension, ActivityDefinition.subject[x].extension, ActivityDefinition.subject[x].extension:alternateReference, ActivityDefinition.kind.extension, ActivityDefinition.kind.extension:kind, ActivityDefinition.location.extension, ActivityDefinition.location.extension:location, ActivityDefinition.participant.extension, ActivityDefinition.participant.extension:typeCanonical, ActivityDefinition.participant.extension:typeReference, ActivityDefinition.participant.extension:function, ActivityDefinition.participant.modifierExtension, ActivityDefinition.participant.type.extension, ActivityDefinition.participant.type.extension:type, ActivityDefinition.product[x].extension, ActivityDefinition.product[x].extension:alternateReference, ActivityDefinition.specimenRequirement.extension, ActivityDefinition.specimenRequirement.extension:specimenRequirement, ActivityDefinition.observationRequirement.extension, ActivityDefinition.observationRequirement.extension:observationRequirement, ActivityDefinition.observationResultRequirement.extension, ActivityDefinition.observationResultRequirement.extension:observationResultRequirement, ActivityDefinition.dynamicValue.extension, ActivityDefinition.dynamicValue.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron