0.1.0 - ci-build

VPImplementationGuide - Local Development build (v0.1.0). See the Directory of published versions

Extension: PopulationRecommendationExtension

Official URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-population-recommendation-extension Version: 0.1.0
Active as of 2022-08-23 Computable Name: VPPopulationRecommendationExtension

Context of Use

This extension may be used on the following element(s):

  • Element

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Mandatory: 6 elements (8 nested mandatory elements)
Must-Support: 16 elements
Fixed Value: 4 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPopulationRecommendationExtension
... extension 1..*ExtensionExtension
... extension:targetDisease S1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"targetDisease"
.... value[x] S1..1CodeableConceptValue of extension
Binding: ICD10ValueSet (required)
..... coding S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
...... code S1..1codeSymbol in syntax defined by the system
... extension:ageStart S0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"ageStart"
.... value[x] SI1..1QuantityValue of extension
age-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
..... value S1..1decimalNumerical value (with implicit precision)
..... system S1..1uriSystem that defines coded unit form
..... code S1..1codeCoded form of the unit
Binding: CommonUCUMCodesForAge (required)
.... extension 0..0
.... url 1..1uri"ageEnd"
.... value[x] SI1..1QuantityValue of extension
age-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
..... value S1..1decimalNumerical value (with implicit precision)
..... system S1..1uriSystem that defines coded unit form
..... code S1..1codeCoded form of the unit
Binding: CommonUCUMCodesForAge (required)
... location S0..*(Complex)LocationExtension
URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-location-extension
... url 1..1uri"https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-population-recommendation-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPopulationRecommendationExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:targetDisease S1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"targetDisease"
.... value[x] S1..1CodeableConceptValue of extension
Binding: ICD10ValueSet (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"ageStart"
.... value[x] SI1..1QuantityValue of extension
age-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit Σ0..1stringUnit representation
..... system SΣI1..1uriSystem that defines coded unit form
..... code SΣ1..1codeCoded form of the unit
Binding: CommonUCUMCodesForAge (required)
... extension:ageEnd S0..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"ageEnd"
.... value[x] SI1..1QuantityValue of extension
age-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit Σ0..1stringUnit representation
..... system SΣI1..1uriSystem that defines coded unit form
..... code SΣ1..1codeCoded form of the unit
Binding: CommonUCUMCodesForAge (required)
... location S0..*(Complex)LocationExtension
URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-location-extension
... url 1..1uri"https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-population-recommendation-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 6 elements (8 nested mandatory elements)
Must-Support: 16 elements
Fixed Value: 4 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPopulationRecommendationExtension
... extension 1..*ExtensionExtension
... extension:targetDisease S1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"targetDisease"
.... value[x] S1..1CodeableConceptValue of extension
Binding: ICD10ValueSet (required)
..... coding S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
...... code S1..1codeSymbol in syntax defined by the system
... extension:ageStart S0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"ageStart"
.... value[x] SI1..1QuantityValue of extension
age-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
..... value S1..1decimalNumerical value (with implicit precision)
..... system S1..1uriSystem that defines coded unit form
..... code S1..1codeCoded form of the unit
Binding: CommonUCUMCodesForAge (required)
.... extension 0..0
.... url 1..1uri"ageEnd"
.... value[x] SI1..1QuantityValue of extension
age-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
..... value S1..1decimalNumerical value (with implicit precision)
..... system S1..1uriSystem that defines coded unit form
..... code S1..1codeCoded form of the unit
Binding: CommonUCUMCodesForAge (required)
... location S0..*(Complex)LocationExtension
URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-location-extension
... url 1..1uri"https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-population-recommendation-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPopulationRecommendationExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:targetDisease S1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"targetDisease"
.... value[x] S1..1CodeableConceptValue of extension
Binding: ICD10ValueSet (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"ageStart"
.... value[x] SI1..1QuantityValue of extension
age-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit Σ0..1stringUnit representation
..... system SΣI1..1uriSystem that defines coded unit form
..... code SΣ1..1codeCoded form of the unit
Binding: CommonUCUMCodesForAge (required)
... extension:ageEnd S0..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"ageEnd"
.... value[x] SI1..1QuantityValue of extension
age-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit Σ0..1stringUnit representation
..... system SΣI1..1uriSystem that defines coded unit form
..... code SΣ1..1codeCoded form of the unit
Binding: CommonUCUMCodesForAge (required)
... location S0..*(Complex)LocationExtension
URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-location-extension
... url 1..1uri"https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-population-recommendation-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:targetDisease.value[x]requiredVPICD10ValueSet
Extension.extension:ageStart.value[x].comparatorrequiredQuantityComparator
Extension.extension:ageStart.value[x].coderequiredCommonUCUMCodesForAge
Extension.extension:ageEnd.value[x].comparatorrequiredQuantityComparator
Extension.extension:ageEnd.value[x].coderequiredCommonUCUMCodesForAge

Constraints

IdGradePathDetailsRequirements
ele-1errorExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:targetDiseaseMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:targetDisease.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:targetDisease.value[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:targetDisease.value[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:targetDisease.value[x].codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:targetDisease.value[x].coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:targetDisease.value[x].coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:targetDisease.value[x].coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:targetDisease.value[x].coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:targetDisease.value[x].coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:targetDisease.value[x].coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:targetDisease.value[x].coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:targetDisease.value[x].textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageStartAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ageStartMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ageStart.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
age-1errorExtension.extension:ageStart.value[x]There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
: (code.exists() or value.empty()) and (system.empty() or system = %ucum) and (value.empty() or value.hasValue().not() or value > 0)
ele-1errorExtension.extension:ageStart.value[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ageStart.value[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ageStart.value[x].valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageStart.value[x].comparatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageStart.value[x].unitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageStart.value[x].systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageStart.value[x].codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageEndAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ageEndMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ageEnd.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
age-1errorExtension.extension:ageEnd.value[x]There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
: (code.exists() or value.empty()) and (system.empty() or system = %ucum) and (value.empty() or value.hasValue().not() or value > 0)
ele-1errorExtension.extension:ageEnd.value[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ageEnd.value[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ageEnd.value[x].valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageEnd.value[x].comparatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageEnd.value[x].unitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageEnd.value[x].systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ageEnd.value[x].codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:locationMust have either extensions or value[x], not both
: extension.exists() != value.exists()