Making EHR Data More available for Research and Public Health (MedMorph)
0.2.0 - STU 1 draft
Making EHR Data More available for Research and Public Health (MedMorph)
0.2.0 - STU 1 draft
This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) (v0.2.0: STU 1 Draft) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-valueset |
| Version: | 0.2.0 |
| Name: | USPublicHealthValueSet |
| Title: | USPH ValueSet |
| Status: | Draft as of 9/1/19 |
| Definition: | This is the ValueSet Resource profile for the IG for specifying various valuesets to be used in public health reporting. |
| Publisher: | HL7 International - Public Health Work Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-valueset
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shareable ValueSet
Summary
Mandatory: 4 elements (6 nested mandatory elements)
Must-Support: 12 elements
Fixed Value: 6 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Shareable ValueSet
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet | 1..1 | Shareable ValueSet | USPH ValueSet | |
  extension | S | 1..* | Extension | Extension |
 valueset-steward | S | 1..1 | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
| valueset-author | S | 1..1 | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
  Slices for useContext | S | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code.system, value:code.code |
  useContext:ph-reporting | 0..* | UsageContext | The context that the content is intended to support | |
  code | ||||
  system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program |
 display | S | 0..1 | string | Representation defined by the system Fixed Value: A program/project of work for which this artifact is applicable. |
  value[x] | S | 1..1 | CodeableConcept | Value that defines the context |
| coding | S | 1..1 | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-valueset-usecontext-codes |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ph-reporting |
| display | S | 0..1 | string | Representation defined by the system Fixed Value: ValueSet is to be used in the context of public health reporting use cases. |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | I | 1..1 | Shareable ValueSet | USPH ValueSet |
| 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| valueset-steward | S | 1..1 | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
| valueset-author | S | 1..1 | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 1..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 | Σ | 1..1 | string | Business version of the value set |
| name | ΣI | 1..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 | Σ | 1..1 | boolean | For testing purposes, not real usage |
| date | Σ | 0..1 | dateTime | Date last changed |
| publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | 1..1 | markdown | Natural language description of the value set | |
 Slices for useContext | SΣ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code.system, value:code.code |
 useContext:ph-reporting | Σ | 0..* | UsageContext | The context that the content is intended to support |
 id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| 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. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 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 | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program |
| display | SΣ | 0..1 | string | Representation defined by the system Fixed Value: A program/project of work for which this artifact is applicable. |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| value[x] | SΣ | 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 | |
| Slices for 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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-valueset-usecontext-codes |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ph-reporting |
| display | SΣ | 0..1 | string | Representation defined by the system Fixed Value: ValueSet is to be used in the context of public health reporting use cases. |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| 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 | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter |
| 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 | ΣI | 0..1 | uri | The system the codes come from |
| version | Σ | 0..1 | string | Specific version of the code system referred to |
| concept | I | 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) Max Binding: AllLanguages: A human language. | |
| 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 | ΣI | 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 | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
| exclude | I | 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 | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
| 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 | I | 0..1 | code | Code - if blank, this is not a selectable code |
| display | I | 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 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | I | 1..1 | Shareable ValueSet | USPH ValueSet |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| valueset-steward | 1..1 | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward | |
| valueset-author | 1..1 | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author | |
| Slices for useContext | Σ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code.system, value:code.code |
| useContext:ph-reporting | Σ | 0..* | UsageContext | The context that the content is intended to support |
| code | Σ | 1..1 | Coding | Type of context being specified |
| 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 |
| display | Σ | 0..1 | string | Representation defined by the system Fixed Value: A program/project of work for which this artifact is applicable. |
| value[x] | Σ | 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. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-valueset-usecontext-codes |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ph-reporting |
| display | Σ | 0..1 | string | Representation defined by the system Fixed Value: ValueSet is to be used in the context of public health reporting use cases. |
| Documentation for this format | ||||
This structure is derived from Shareable ValueSet
Summary
Mandatory: 4 elements (6 nested mandatory elements)
Must-Support: 12 elements
Fixed Value: 6 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Shareable ValueSet
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | 1..1 | Shareable ValueSet | USPH ValueSet | |
| extension | S | 1..* | Extension | Extension |
| valueset-steward | S | 1..1 | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
| valueset-author | S | 1..1 | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
| Slices for useContext | S | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code.system, value:code.code |
| useContext:ph-reporting | 0..* | UsageContext | The context that the content is intended to support | |
| code | ||||
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program |
| display | S | 0..1 | string | Representation defined by the system Fixed Value: A program/project of work for which this artifact is applicable. |
| value[x] | S | 1..1 | CodeableConcept | Value that defines the context |
| coding | S | 1..1 | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-valueset-usecontext-codes |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ph-reporting |
| display | S | 0..1 | string | Representation defined by the system Fixed Value: ValueSet is to be used in the context of public health reporting use cases. |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | I | 1..1 | Shareable ValueSet | USPH ValueSet |
| 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| valueset-steward | S | 1..1 | ContactDetail | Entity responsible for Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
| valueset-author | S | 1..1 | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 1..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 | Σ | 1..1 | string | Business version of the value set |
| name | ΣI | 1..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 | Σ | 1..1 | boolean | For testing purposes, not real usage |
| date | Σ | 0..1 | dateTime | Date last changed |
| publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | 1..1 | markdown | Natural language description of the value set | |
| Slices for useContext | SΣ | 1..* | UsageContext | The context that the content is intended to support Slice: Unordered, Open by value:code.system, value:code.code |
| useContext:ph-reporting | Σ | 0..* | UsageContext | The context that the content is intended to support |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| 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. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 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 | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program |
| display | SΣ | 0..1 | string | Representation defined by the system Fixed Value: A program/project of work for which this artifact is applicable. |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| value[x] | SΣ | 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 | |
| Slices for 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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-valueset-usecontext-codes |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ph-reporting |
| display | SΣ | 0..1 | string | Representation defined by the system Fixed Value: ValueSet is to be used in the context of public health reporting use cases. |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| 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 | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter |
| 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 | ΣI | 0..1 | uri | The system the codes come from |
| version | Σ | 0..1 | string | Specific version of the code system referred to |
| concept | I | 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) Max Binding: AllLanguages: A human language. | |
| 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 | ΣI | 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 | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
| exclude | I | 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 | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
| 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 | I | 0..1 | code | Code - if blank, this is not a selectable code |
| display | I | 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 | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| ValueSet.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ValueSet.status | required | PublicationStatus |
| ValueSet.useContext:ph-reporting.code | extensible | Fixed Value: program |
| ValueSet.useContext:ph-reporting.value[x] | example | Context of Use ValueSet |
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSet |
| ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ValueSet.compose.include.concept.designation.use | extensible | DesignationUse |
| ValueSet.compose.include.filter.op | required | FilterOperator |
| Id | Path | Details | Requirements |
| dom-2 | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | ValueSet | 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 | ValueSet | 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 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | ValueSet | A resource should have narrative for robust management : text.`div`.exists() | |
| vsd-0 | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| ele-1 | ValueSet.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.extension:valueset-steward | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.extension:valueset-steward | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.extension:valueset-author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.extension:valueset-author | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.experimental | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.publisher | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.useContext:ph-reporting.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.useContext:ph-reporting.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.useContext:ph-reporting.code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.useContext:ph-reporting.code.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.code.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.code.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.code.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.code.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.useContext:ph-reporting.value[x].extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.useContext:ph-reporting.value[x].coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.useContext:ph-reporting.value[x].text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.jurisdiction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.immutable | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.copyright | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.lockedDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.inactive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| vsd-1 | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists() | |
| vsd-2 | ValueSet.compose.include | A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists() | |
| vsd-3 | ValueSet.compose.include | Cannot have both concept and filter : concept.empty() or filter.empty() | |
| ele-1 | ValueSet.compose.include.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.include.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.include.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.include.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.include.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.concept | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.concept.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.include.concept.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.include.concept.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.include.concept.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.include.concept.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.concept.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.concept.designation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.concept.designation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.include.concept.designation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.include.concept.designation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.include.concept.designation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.include.concept.designation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.concept.designation.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.concept.designation.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.filter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.filter.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.include.filter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.include.filter.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.compose.include.filter.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.compose.include.filter.property | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.filter.op | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.filter.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.include.valueSet | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.compose.exclude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.expansion.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.expansion.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.expansion.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.expansion.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.timestamp | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.total | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.offset | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.parameter.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.expansion.parameter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.expansion.parameter.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.expansion.parameter.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.expansion.parameter.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.parameter.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.contains | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| vsd-6 | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() | |
| vsd-9 | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true | |
| vsd-10 | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() | |
| ele-1 | ValueSet.expansion.contains.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.expansion.contains.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.expansion.contains.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ValueSet.expansion.contains.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ValueSet.expansion.contains.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.contains.abstract | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.contains.inactive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.contains.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.contains.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.contains.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.contains.designation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ValueSet.expansion.contains.contains | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Public Health Work Group. Package hl7.fhir.us.medmorph#0.2.0 based on FHIR 4.0.1. Generated 2021-12-08
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change