openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
| Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/openimis-activitiy-definition | Version: 1.0.0 | |||
| Active as of 2022-05-31 | Responsible: openIMIS Initiative | Computable Name: OpenIMISActivityDefinition | ||
Defines a ActivityDefinition for openIMIS which maps to a Medical Service.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ActivityDefinition
Summary
Mandatory: 13 elements (11 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 36 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from ActivityDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ActivityDefinition | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |
  id | 0..1 | string | ActivityDefinition UUID | |
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 unit-price | 1..1 | Money | Unit Price URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/unit-price | |
| activity-definition-level | 0..1 | CodeableConcept | Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/activity-definition-level Binding: Level (ActivityDefinition) (required) | |
  Slices for identifier | S | 1..* | Identifier | Additional identifier for the activity definition Slice: Unordered, Closed by value:type.coding.code |
  identifier:All Slices | Content/Rules for all slices | |||
 type | 1..1 | CodeableConcept | Description of identifier | |
 coding | ||||
  code | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | |
 value | 1..1 | string | The value that is unique | |
| identifier:Code | S | 1..1 | Identifier | Additional identifier for the activity definition |
 type | ||||
| coding | ||||
| code | 1..1 | code | ActivityDefinition openIMIS Code Required Pattern: Code | |
 identifier:UUID | 0..1 | Identifier | Additional identifier for the activity definition | |
| type | ||||
| coding | ||||
| code | 1..1 | code | ActivityDefinition openIMIS UUID Required Pattern: UUID | |
| version | 0..0 | |||
| name | 1..1 | string | Code of the Medical Service (computer friendly) | |
| title | 1..1 | string | Name of the Medical Service (human friendly) | |
| subtitle | 0..0 | |||
| status | 1..1 | code | draft | active | retired | unknown Required Pattern: active | |
| experimental | 0..0 | |||
| subject[x] | 0..0 | |||
| date | 1..1 | dateTime | Date last changed | |
| publisher | 0..0 | |||
| contact | 0..0 | |||
| description | 0..0 | |||
| Slices for useContext | 1..4 | UsageContext | The context that the content is intended to support Slice: Unordered, Closed by value:code | |
| useContext:All Slices | Content/Rules for all slices | |||
| code | 1..1 | Coding | Type of context being specified Binding: Usage Context Type (ActivityDefinition) (required) | |
| useContext:Gender | 0..1 | UsageContext | Usage Context per Gender | |
 code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Gender | |
 value[x] | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value that defines the context | |
| coding | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Gender Type (ActivityDefinition|Medication) (required) | |
| useContext:Age | 0..1 | UsageContext | Usage Context per Age | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Age | |
| value[x] | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value that defines the context | |
| coding | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Age Type (ActivityDefinition|Medication) (required) | |
| useContext:Category | 0..1 | UsageContext | Usage Context per Workflow | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Workflow Setting | |
| value[x] | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value that defines the context | |
| coding | 1..1 | Coding | Code defined by a terminology system Binding: Usage Context for Workflow Type (ActivityDefinition) (required) | |
| useContext:CareType | 1..1 | UsageContext | Usage Context per Care Type | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical Venue | |
| value[x] | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value that defines the context | |
| coding | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Venue Type (ActivityDefinition) (required) | |
| jurisdiction | 0..0 | |||
| purpose | 0..0 | |||
| usage | 0..0 | |||
| copyright | 0..0 | |||
| approvalDate | 0..0 | |||
| lastReviewDate | 0..0 | |||
| effectivePeriod | 0..0 | |||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: Service Type (ActivityDefinition) (required) | |
| author | 0..0 | |||
| editor | 0..0 | |||
| reviewer | 0..0 | |||
| endorser | 0..0 | |||
| relatedArtifact | 0..0 | |||
| library | 0..0 | |||
| kind | 0..1 | code | Kind of resource Required Pattern: ServiceRequest | |
| profile | 0..0 | |||
| code | 0..0 | |||
| intent | 0..0 | |||
| priority | 0..0 | |||
| doNotPerform | 0..0 | |||
| timing[x] | 0..1 | Timing | When activity is to occur Slice: Unordered, Open by type:$this | |
| timingTiming | 0..1 | Timing | When activity is to occur | |
| repeat | ||||
| frequency | 1..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | |
| period | 1..1 | decimal | Frequency (days) | |
| periodUnit | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: d | |
| location | 0..0 | |||
| participant | 0..0 | |||
| product[x] | 0..0 | |||
| quantity | 0..0 | |||
| dosage | 0..0 | |||
| bodySite | 0..0 | |||
| specimenRequirement | 0..0 | |||
| observationRequirement | 0..0 | |||
| observationResultRequirement | 0..0 | |||
| transform | 0..0 | |||
| dynamicValue | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ActivityDefinition | I | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | ||||
 id | Σ | 0..1 | string | ActivityDefinition UUID | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| unit-price | 1..1 | Money | Unit Price URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/unit-price | |||||
| activity-definition-level | 0..1 | CodeableConcept | Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/activity-definition-level Binding: Level (ActivityDefinition) (required) | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
| Slices for identifier | SΣ | 1..* | Identifier | Additional identifier for the activity definition Slice: Unordered, Closed by value:type.coding.code | ||||
| identifier:All Slices | Content/Rules for all slices | |||||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:Code | SΣ | 1..1 | Identifier | Additional identifier for the activity definition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | ActivityDefinition openIMIS Code Required Pattern: Code | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:UUID | Σ | 0..1 | Identifier | Additional identifier for the activity definition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | ActivityDefinition openIMIS UUID Required Pattern: UUID | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| name | ΣI | 1..1 | string | Code of the Medical Service (computer friendly) | ||||
| title | Σ | 1..1 | string | Name of the Medical Service (human friendly) | ||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active | ||||
| date | Σ | 1..1 | dateTime | Date last changed | ||||
| Slices for useContext | Σ | 1..4 | UsageContext | The context that the content is intended to support Slice: Unordered, Closed by value:code | ||||
| useContext:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: Usage Context Type (ActivityDefinition) (required) | ||||
 value[x] | Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | |||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| useContext:Gender | Σ | 0..1 | UsageContext | Usage Context per Gender | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Gender | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| Slices for value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Closed by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| value[x]:valueCodeableConcept | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Gender Type (ActivityDefinition|Medication) (required) | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| useContext:Age | Σ | 0..1 | UsageContext | Usage Context per Age | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Age | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| Slices for value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Closed by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| value[x]:valueCodeableConcept | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Age Type (ActivityDefinition|Medication) (required) | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| useContext:Category | Σ | 0..1 | UsageContext | Usage Context per Workflow | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Workflow Setting | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| Slices for value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Closed by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| value[x]:valueCodeableConcept | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Binding: Usage Context for Workflow Type (ActivityDefinition) (required) | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| useContext:CareType | Σ | 1..1 | UsageContext | Usage Context per Care Type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical Venue | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| Slices for value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Closed by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| value[x]:valueCodeableConcept | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Venue Type (ActivityDefinition) (required) | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: Service Type (ActivityDefinition) (required) | |||||
| kind | Σ | 0..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. Required Pattern: ServiceRequest | ||||
| Slices for timing[x] | 0..1 | Timing | When activity is to occur Slice: Unordered, Closed by type:$this | |||||
| timing[x]:timingTiming | 0..1 | Timing | When activity is to occur | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event | Σ | 0..* | dateTime | When the event occurs | ||||
| repeat | ΣI | 0..1 | Element | When the event is to occur | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration | Duration | |||||||
| boundsRange | Range | |||||||
| boundsPeriod | Period | |||||||
| count | Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration | Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax | Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency | Σ | 1..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | ||||
| frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period | Σ | 1..1 | decimal | Frequency (days) | ||||
| periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit | Σ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Required Pattern: d | ||||
| dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay | Σ | 0..* | time | Time of day for action | ||||
| when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ActivityDefinition | I | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context |
| Slices for identifier | Σ | 1..* | Identifier | Additional identifier for the activity definition Slice: Unordered, Closed by value:type.coding.code |
| identifier:Code | Σ | 1..1 | Identifier | Additional identifier for the activity definition |
| Documentation for this format | ||||
This structure is derived from ActivityDefinition
Summary
Mandatory: 13 elements (11 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 36 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ActivityDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ActivityDefinition | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |
| id | 0..1 | string | ActivityDefinition UUID | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| unit-price | 1..1 | Money | Unit Price URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/unit-price | |
| activity-definition-level | 0..1 | CodeableConcept | Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/activity-definition-level Binding: Level (ActivityDefinition) (required) | |
| Slices for identifier | S | 1..* | Identifier | Additional identifier for the activity definition Slice: Unordered, Closed by value:type.coding.code |
| identifier:All Slices | Content/Rules for all slices | |||
| type | 1..1 | CodeableConcept | Description of identifier | |
| coding | ||||
| code | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | |
| value | 1..1 | string | The value that is unique | |
| identifier:Code | S | 1..1 | Identifier | Additional identifier for the activity definition |
| type | ||||
| coding | ||||
| code | 1..1 | code | ActivityDefinition openIMIS Code Required Pattern: Code | |
| identifier:UUID | 0..1 | Identifier | Additional identifier for the activity definition | |
| type | ||||
| coding | ||||
| code | 1..1 | code | ActivityDefinition openIMIS UUID Required Pattern: UUID | |
| version | 0..0 | |||
| name | 1..1 | string | Code of the Medical Service (computer friendly) | |
| title | 1..1 | string | Name of the Medical Service (human friendly) | |
| subtitle | 0..0 | |||
| status | 1..1 | code | draft | active | retired | unknown Required Pattern: active | |
| experimental | 0..0 | |||
| subject[x] | 0..0 | |||
| date | 1..1 | dateTime | Date last changed | |
| publisher | 0..0 | |||
| contact | 0..0 | |||
| description | 0..0 | |||
| Slices for useContext | 1..4 | UsageContext | The context that the content is intended to support Slice: Unordered, Closed by value:code | |
| useContext:All Slices | Content/Rules for all slices | |||
| code | 1..1 | Coding | Type of context being specified Binding: Usage Context Type (ActivityDefinition) (required) | |
| useContext:Gender | 0..1 | UsageContext | Usage Context per Gender | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: gender | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Gender | |
| value[x] | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value that defines the context | |
| coding | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Gender Type (ActivityDefinition|Medication) (required) | |
| useContext:Age | 0..1 | UsageContext | Usage Context per Age | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: age | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Age | |
| value[x] | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value that defines the context | |
| coding | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Age Type (ActivityDefinition|Medication) (required) | |
| useContext:Category | 0..1 | UsageContext | Usage Context per Workflow | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Workflow Setting | |
| value[x] | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value that defines the context | |
| coding | 1..1 | Coding | Code defined by a terminology system Binding: Usage Context for Workflow Type (ActivityDefinition) (required) | |
| useContext:CareType | 1..1 | UsageContext | Usage Context per Care Type | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: venue | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical Venue | |
| value[x] | 1..1 | CodeableConcept | Value that defines the context Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value that defines the context | |
| coding | 1..2 | Coding | Code defined by a terminology system Binding: Usage Context for Venue Type (ActivityDefinition) (required) | |
| jurisdiction | 0..0 | |||
| purpose | 0..0 | |||
| usage | 0..0 | |||
| copyright | 0..0 | |||
| approvalDate | 0..0 | |||
| lastReviewDate | 0..0 | |||
| effectivePeriod | 0..0 | |||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: Service Type (ActivityDefinition) (required) | |
| author | 0..0 | |||
| editor | 0..0 | |||
| reviewer | 0..0 | |||
| endorser | 0..0 | |||
| relatedArtifact | 0..0 | |||
| library | 0..0 | |||
| kind | 0..1 | code | Kind of resource Required Pattern: ServiceRequest | |
| profile | 0..0 | |||
| code | 0..0 | |||
| intent | 0..0 | |||
| priority | 0..0 | |||
| doNotPerform | 0..0 | |||
| timing[x] | 0..1 | Timing | When activity is to occur Slice: Unordered, Open by type:$this | |
| timingTiming | 0..1 | Timing | When activity is to occur | |
| repeat | ||||
| frequency | 1..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | |
| period | 1..1 | decimal | Frequency (days) | |
| periodUnit | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: d | |
| location | 0..0 | |||
| participant | 0..0 | |||
| product[x] | 0..0 | |||
| quantity | 0..0 | |||
| dosage | 0..0 | |||
| bodySite | 0..0 | |||
| specimenRequirement | 0..0 | |||
| observationRequirement | 0..0 | |||
| observationResultRequirement | 0..0 | |||
| transform | 0..0 | |||
| dynamicValue | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ActivityDefinition | I | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | ||||
| id | Σ | 0..1 | string | ActivityDefinition UUID | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| unit-price | 1..1 | Money | Unit Price URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/unit-price | |||||
| activity-definition-level | 0..1 | CodeableConcept | Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/activity-definition-level Binding: Level (ActivityDefinition) (required) | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
| Slices for identifier | SΣ | 1..* | Identifier | Additional identifier for the activity definition Slice: Unordered, Closed by value:type.coding.code | ||||
| identifier:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:Code | SΣ | 1..1 | Identifier | Additional identifier for the activity definition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | ActivityDefinition openIMIS Code Required Pattern: Code | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:UUID | Σ | 0..1 | Identifier | Additional identifier for the activity definition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | ActivityDefinition openIMIS UUID Required Pattern: UUID | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| name | ΣI | 1..1 | string | Code of the Medical Service (computer friendly) | ||||
| title | Σ | 1..1 | string | Name of the Medical Service (human friendly) | ||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active | ||||
| date | Σ | 1..1 | dateTime | Date last changed | ||||
| Slices for useContext | Σ | 1..4 | UsageContext | The context that the content is intended to support Slice: Unordered, Closed by value:code | ||||
| useContext:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: Usage Context Type (ActivityDefinition) (required) | ||||
| value[x] | Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | |||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| useContext:Gender | Σ | 0..1 | UsageContext | Usage Context per Gender | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||