FHIR implementation guide of AP-HP FormBuilder
1.0.0 - ci-build France flag

FHIR implementation guide of AP-HP FormBuilder - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AP-HP FormBuilder ValueSet

Official URL: https://aphp.fr/ig/fhir/formbuilder/StructureDefinition/FBValueSet Version: 1.0.0
Active as of 2025-09-16 Computable Name: FBValueSet

Profil de ValueSet pour la pleine utilisation du FormBuilder (et de ses fonctionalités terminologiques)

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
.... useContext:program Σ 0..1 UsageContext The context that the content is intended to support
..... 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: program
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: Some program that gather CodeSystem, ValueSet and Questionnaire together (example)

doco Documentation for this format

Terminology Bindings

PathConformitéValueSet / CodeURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ValueSet.useContext:program.codeextensiblePattern Value: program
http://hl7.org/fhir/ValueSet/usage-context-type
From the FHIR Standard
ValueSet.useContext:program.value[x]exampleProgramExample(a valid code from Some program that gather CodeSystem, ValueSet and Questionnaire together)
https://aphp.fr/ig/fhir/formbuilder/ValueSet/ProgramExample
From this IG

Constraints

IdGradePath(s)DétailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName 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}')

This structure is derived from ValueSet

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... Slices pour useContext 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:program 0..1 UsageContext The context that the content is intended to support
..... 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: program
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: Some program that gather CodeSystem, ValueSet and Questionnaire together (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformitéValueSetURI
ValueSet.useContext:program.value[x]exampleProgramExample(a valid code from Some program that gather CodeSystem, ValueSet and Questionnaire together)
https://aphp.fr/ig/fhir/formbuilder/ValueSet/ProgramExample
From this IG
NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-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
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
... version Σ 0..1 string Business version of the value set
... name ΣC 0..1 string Name for this value set (computer friendly)
... title Σ 0..1 string Name for this value set (human friendly)
... 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
... 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 value set
... Slices pour useContext Σ 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:program Σ 0..1 UsageContext The context that the content is intended to support
..... 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: program
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: Some program that gather CodeSystem, ValueSet and Questionnaire together (example)
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Why this value set is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation 0..* BackboneElement Additional representations for this concept
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Bindings AdditionnelsBut
AllLanguages Binding Max
....... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
....... value 1..1 string The text value for this designation
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
...... value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... contains C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system 0..1 uri System value for the code
..... abstract 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version 0..1 string Version in which this code/display is defined
..... code C 0..1 code Code - if blank, this is not a selectable code
..... display C 0..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformitéValueSet / CodeURI
ValueSet.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Bindings Additionnels But
AllLanguages Binding Max
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ValueSet.useContext:program.codeextensiblePattern Value: program
http://hl7.org/fhir/ValueSet/usage-context-type
From the FHIR Standard
ValueSet.useContext:program.value[x]exampleProgramExample(a valid code from Some program that gather CodeSystem, ValueSet and Questionnaire together)
https://aphp.fr/ig/fhir/formbuilder/ValueSet/ProgramExample
From this IG
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Bindings Additionnels But
AllLanguages Binding Max
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DétailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName 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}')
vsd-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

This structure is derived from ValueSet

Résumé

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ValueSet.useContext

Key Elements View

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
.... useContext:program Σ 0..1 UsageContext The context that the content is intended to support
..... 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: program
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: Some program that gather CodeSystem, ValueSet and Questionnaire together (example)

doco Documentation for this format

Terminology Bindings

PathConformitéValueSet / CodeURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ValueSet.useContext:program.codeextensiblePattern Value: program
http://hl7.org/fhir/ValueSet/usage-context-type
From the FHIR Standard
ValueSet.useContext:program.value[x]exampleProgramExample(a valid code from Some program that gather CodeSystem, ValueSet and Questionnaire together)
https://aphp.fr/ig/fhir/formbuilder/ValueSet/ProgramExample
From this IG

Constraints

IdGradePath(s)DétailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName 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}')

Differential View

This structure is derived from ValueSet

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... Slices pour useContext 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:program 0..1 UsageContext The context that the content is intended to support
..... 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: program
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: Some program that gather CodeSystem, ValueSet and Questionnaire together (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformitéValueSetURI
ValueSet.useContext:program.value[x]exampleProgramExample(a valid code from Some program that gather CodeSystem, ValueSet and Questionnaire together)
https://aphp.fr/ig/fhir/formbuilder/ValueSet/ProgramExample
From this IG

Snapshot View

NomDrapeauxCard.TypeDescription et contraintes    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-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
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
... version Σ 0..1 string Business version of the value set
... name ΣC 0..1 string Name for this value set (computer friendly)
... title Σ 0..1 string Name for this value set (human friendly)
... 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
... 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 value set
... Slices pour useContext Σ 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code
.... useContext:program Σ 0..1 UsageContext The context that the content is intended to support
..... 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: program
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: Some program that gather CodeSystem, ValueSet and Questionnaire together (example)
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Why this value set is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation 0..* BackboneElement Additional representations for this concept
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Bindings AdditionnelsBut
AllLanguages Binding Max
....... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
....... value 1..1 string The text value for this designation
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
...... value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... contains C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system 0..1 uri System value for the code
..... abstract 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version 0..1 string Version in which this code/display is defined
..... code C 0..1 code Code - if blank, this is not a selectable code
..... display C 0..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformitéValueSet / CodeURI
ValueSet.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Bindings Additionnels But
AllLanguages Binding Max
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ValueSet.useContext:program.codeextensiblePattern Value: program
http://hl7.org/fhir/ValueSet/usage-context-type
From the FHIR Standard
ValueSet.useContext:program.value[x]exampleProgramExample(a valid code from Some program that gather CodeSystem, ValueSet and Questionnaire together)
https://aphp.fr/ig/fhir/formbuilder/ValueSet/ProgramExample
From this IG
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Bindings Additionnels But
AllLanguages Binding Max
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DétailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName 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}')
vsd-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

This structure is derived from ValueSet

Résumé

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ValueSet.useContext

 

Other representations of profile: CSV, Excel, Schematron