VPImplementationGuide - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: VaccinationDose
| Official URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose | Version: 0.1.0 | |||
| Active as of 2022-08-23 | Computable Name: VPVaccinationDose | |||
VaccinationDose models one of the doses of a vaccination given as part of a vaccination scheme.
Usage:
- Refer to this Resource Profile:
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Basic
Summary
Mandatory: 5 elements
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-base-extension
- https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-single-extension
- https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-repeating-extension
This structure is derived from Basic
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  Basic | I | 0..* | Basic | Resource for non-supported content vp-vaccination-dose-extension-only-one-kind-invariant: A vaccination dose can either be a single dose or a repeating dose. | ||||
  id | Σ | 0..1 | string | 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.
| |||||
| 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 | |||||
 base | S | 1..1 | (Complex) | VaccinationDoseBaseExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-base-extension | ||||
| singleDose | SI | 0..1 | (Complex) | VaccinationDoseSingleExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-single-extension | ||||
| repeatingDose | S | 0..1 | (Complex) | VaccinationDoseRepeatingExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-repeating-extension | ||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifier | ||||
 code | ?!SΣ | 1..1 | CodeableConcept | Kind of Resource Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR. | ||||
 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 | SΣ | 1..1 | 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 | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: VaccinationDose | ||||
| 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 | ||||
 subject | SΣ | 1..1 | Reference(VaccinationScheme) | Identifies the focus of this resource | ||||
| created | Σ | 0..1 | date | When created | ||||
| author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Who created | ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Basic | I | 0..* | Basic | Resource for non-supported content vp-vaccination-dose-extension-only-one-kind-invariant: A vaccination dose can either be a single dose or a repeating dose. |
| base | 1..1 | (Complex) | VaccinationDoseBaseExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-base-extension | |
| singleDose | I | 0..1 | (Complex) | VaccinationDoseSingleExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-single-extension |
| repeatingDose | 0..1 | (Complex) | VaccinationDoseRepeatingExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-repeating-extension | |
| code | ?!Σ | 1..1 | CodeableConcept | Kind of Resource Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR. |
 coding | Σ | 1..1 | Coding | Code defined by a terminology system |
 code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: VaccinationDose |
| subject | Σ | 1..1 | Reference(VaccinationScheme) | Identifies the focus of this resource |
| Documentation for this format | ||||
This structure is derived from Basic
Summary
Mandatory: 5 elements
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-base-extension
- https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-single-extension
- https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-repeating-extension
Differential View
This structure is derived from Basic
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Basic | I | 0..* | Basic | Resource for non-supported content vp-vaccination-dose-extension-only-one-kind-invariant: A vaccination dose can either be a single dose or a repeating dose. | ||||
| id | Σ | 0..1 | string | 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.
| |||||
| 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 | |||||
| base | S | 1..1 | (Complex) | VaccinationDoseBaseExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-base-extension | ||||
| singleDose | SI | 0..1 | (Complex) | VaccinationDoseSingleExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-single-extension | ||||
| repeatingDose | S | 0..1 | (Complex) | VaccinationDoseRepeatingExtension URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-repeating-extension | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifier | ||||
| code | ?!SΣ | 1..1 | CodeableConcept | Kind of Resource Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR. | ||||
| 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 | SΣ | 1..1 | 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 | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: VaccinationDose | ||||
| 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 | ||||
| subject | SΣ | 1..1 | Reference(VaccinationScheme) | Identifies the focus of this resource | ||||
| created | Σ | 0..1 | date | When created | ||||
| author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Who created | ||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Basic.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Basic.code | example | BasicResourceTypes |
Constraints
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | Basic | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Basic | 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 | Basic | 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 | Basic | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | Basic | A resource should have narrative for robust management : text.`div`.exists() | |
| vp-vaccination-dose-extension-only-one-kind-invariant | error | Basic | A vaccination dose can either be a single dose or a repeating dose. : extension('https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-single-extension').exists() != extension('https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-vaccination-dose-repeating-extension').exists() | |
| ele-1 | error | Basic.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Basic.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Basic.extension:base | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Basic.extension:base | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Basic.extension:singleDose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Basic.extension:singleDose | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| vp-vaccination-single-dose-timeframe-existance-invariant | error | Basic.extension:singleDose | A single vaccination dose must have 'timeframeStart' and 'timeframeEnd' if its number in the scheme is bigger than 1. : (extension('numberInScheme').first().value <= 1 and extension('timeframeStart').empty() and extension('timeframeEnd').empty()) or (extension('numberInScheme').first().value >= 2 and extension('timeframeStart').exists() and extension('timeframeEnd').exists()) | |
| ele-1 | error | Basic.extension:repeatingDose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Basic.extension:repeatingDose | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Basic.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Basic.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Basic.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Basic.code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Basic.code.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.code.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Basic.code.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Basic.code.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.code.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.code.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.code.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.code.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.code.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Basic.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |