FHIR Implementation Guide Experiment 01
0.0.1 - CI Build
FHIR Implementation Guide Experiment 01
0.0.1 - CI Build
FHIR Implementation Guide Experiment 01 - Local Development build (v0.0.1). See the Directory of published versions
| Official URL: https://about.me/robeastwood/fhir/ig/StructureDefinition/structuredefinition-hl7au-vsd-1 | Version: 0.0.1 | |||
| Draft as of 2022-03-25 | Computable Name: HL7AUValueSetBase | |||
Copyright/Legal: This is free and unencumbered software released into the public domain. |
||||
The purpose of this profile is to enforce conventions for ValueSets, in metadata and structure
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ValueSet
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems hl7au-vsd-base-05: The url should end with the id value, unless it is an AU extended ValueSet |
  id | 1..1 | id | Logical id of this artifact | |
 meta | 1..1 | Meta | Metadata about the resource | |
 versionId | 0..0 | |||
| lastUpdated | 0..0 | |||
| source | 0..0 | |||
| profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/StructureDefinition/shareablevalueset | |
| security | 0..0 | |||
 tag | 0..0 | |||
| implicitRules | 0..0 | |||
| language | 0..0 | |||
| contained | 0..0 | |||
| url | C | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) hl7au-vsd-base-02: The url starts with 'http://terminology.hl7.org.au/ValueSet/' |
| identifier | 1..1 | Identifier | Additional identifier for the value set (business identifier) | |
| use | 0..0 | |||
| type | 0..0 | |||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| value | C | 1..1 | string | The value that is unique hl7au-vsd-base-02: The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' |
| period | 0..0 | |||
| assigner | 0..0 | |||
| version | C | 1..1 | string | Business version of the value set hl7au-vsd-base-01: The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 |
| name | 1..1 | string | Name for this value set (computer friendly) | |
| title | 1..1 | string | Name for this value set (human friendly) | |
| experimental | 1..1 | boolean | For testing purposes, not real usage | |
| date | 1..1 | dateTime | Date last changed | |
| publisher | C | 1..1 | string | Name of the publisher (organization or individual) hl7au-vsd-base-03: The publisher starts with 'Health Level Seven Australia' |
| contact | 1..1 | ContactDetail | Contact details for the publisher | |
| name | 0..0 | |||
 telecom | 1..1 | ContactPoint | Contact details for individual or organization | |
 system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url | |
| value | 1..1 | string | The actual contact point details Fixed Value: http://hl7.com.au | |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| rank | 0..0 | |||
| period | 0..0 | |||
| description | 1..1 | markdown | Natural language description of the value set | |
| useContext | 0..0 | |||
| jurisdiction | 1..1 | CodeableConcept | Intended jurisdiction for value set (if applicable) | |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
| version | 0..0 | |||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AU | |
| display | 0..0 | |||
| userSelected | 0..0 | |||
| text | 0..0 | |||
| purpose | 0..0 | |||
| copyright | C | 1..1 | markdown | Use and/or publishing restrictions hl7au-vsd-base-04: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| hl7au-vsd-base-01 | error | ValueSet.version | The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 : matches('^([1-9]{1,2})[.]([0-9]{1}|[1-9]{1}[0-9]{1})[.]([0-9]{1}|[1-9]{1}[0-9]{1})$') | |
| hl7au-vsd-base-02 | error | ValueSet.url, ValueSet.identifier.value | The url starts with 'http://terminology.hl7.org.au/ValueSet/' : startsWith('http://terminology.hl7.org.au/ValueSet/') | |
| hl7au-vsd-base-03 | error | ValueSet.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-vsd-base-04 | error | ValueSet.copyright | The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' : startsWith('HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.') | |
| hl7au-vsd-base-05 | warning | ValueSet | The url should end with the id value, unless it is an AU extended ValueSet : url.replace('http://terminology.hl7.org.au/ValueSet/','') = id |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems hl7au-vsd-base-05: The url should end with the id value, unless it is an AU extended ValueSet |
 id | Σ | 1..1 | id | Logical id of this artifact |
 meta | Σ | 1..1 | Meta | Metadata about the resource |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/StructureDefinition/shareablevalueset |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | ΣC | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) hl7au-vsd-base-02: The url starts with 'http://terminology.hl7.org.au/ValueSet/' |
| identifier | Σ | 1..1 | Identifier | Additional identifier for the value set (business identifier) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
| value | ΣC | 1..1 | string | The value that is unique hl7au-vsd-base-02: The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' Example General: 123456 |
| version | ΣC | 1..1 | string | Business version of the value set hl7au-vsd-base-01: The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 |
| name | ΣC | 1..1 | string | Name for this value set (computer friendly) |
| title | Σ | 1..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 | Σ | 1..1 | dateTime | Date last changed |
| publisher | ΣC | 1..1 | string | Name of the publisher (organization or individual) hl7au-vsd-base-03: The publisher starts with 'Health Level Seven Australia' |
| contact | Σ | 1..1 | ContactDetail | Contact details for the publisher |
| telecom | Σ | 1..1 | ContactPoint | Contact details for individual or organization |
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url |
| value | Σ | 1..1 | string | The actual contact point details Fixed Value: http://hl7.com.au |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
| description | 1..1 | markdown | Natural language description of the value set | |
| jurisdiction | Σ | 1..1 | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AU |
| copyright | C | 1..1 | markdown | Use and/or publishing restrictions hl7au-vsd-base-04: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ValueSet.status | required | PublicationStatus |
| ValueSet.contact.telecom.system | required | Fixed Value: url |
| ValueSet.contact.telecom.use | required | Fixed Value: work |
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSet |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ValueSet | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| hl7au-vsd-base-01 | error | ValueSet.version | The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 : matches('^([1-9]{1,2})[.]([0-9]{1}|[1-9]{1}[0-9]{1})[.]([0-9]{1}|[1-9]{1}[0-9]{1})$') | |
| hl7au-vsd-base-02 | error | ValueSet.url, ValueSet.identifier.value | The url starts with 'http://terminology.hl7.org.au/ValueSet/' : startsWith('http://terminology.hl7.org.au/ValueSet/') | |
| hl7au-vsd-base-03 | error | ValueSet.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-vsd-base-04 | error | ValueSet.copyright | The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' : startsWith('HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.') | |
| hl7au-vsd-base-05 | warning | ValueSet | The url should end with the id value, unless it is an AU extended ValueSet : url.replace('http://terminology.hl7.org.au/ValueSet/','') = id | |
| vsd-0 | warning | 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}') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems hl7au-vsd-base-05: The url should end with the id value, unless it is an AU extended ValueSet | ||||
| id | Σ | 1..1 | id | Logical id of this artifact | ||||
| meta | Σ | 1..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/StructureDefinition/shareablevalueset | ||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | ΣC | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) hl7au-vsd-base-02: The url starts with 'http://terminology.hl7.org.au/ValueSet/' | ||||
| identifier | Σ | 1..1 | Identifier | Additional identifier for the value set (business identifier) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value | ΣC | 1..1 | string | The value that is unique hl7au-vsd-base-02: The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' Example General: 123456 | ||||
| version | ΣC | 1..1 | string | Business version of the value set hl7au-vsd-base-01: The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 | ||||
| name | ΣC | 1..1 | string | Name for this value set (computer friendly) | ||||
| title | Σ | 1..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 | Σ | 1..1 | dateTime | Date last changed | ||||
| publisher | ΣC | 1..1 | string | Name of the publisher (organization or individual) hl7au-vsd-base-03: The publisher starts with 'Health Level Seven Australia' | ||||
| contact | Σ | 1..1 | ContactDetail | Contact details for the publisher | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| telecom | Σ | 1..1 | ContactPoint | Contact details for individual or organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url | ||||
| value | Σ | 1..1 | string | The actual contact point details Fixed Value: http://hl7.com.au | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| description | 1..1 | markdown | Natural language description of the value set | |||||
| jurisdiction | Σ | 1..1 | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AU | ||||
| immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
| copyright | C | 1..1 | markdown | Use and/or publishing restrictions hl7au-vsd-base-04: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' | ||||
| 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) | ||||
| 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.
| |||||
| 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 | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| ValueSet.status | required | PublicationStatus | ||||
| ValueSet.contact.telecom.system | required | Fixed Value: url | ||||
| ValueSet.contact.telecom.use | required | Fixed Value: work | ||||
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
| ||||
| ValueSet.compose.include.concept.designation.use | extensible | DesignationUse | ||||
| ValueSet.compose.include.filter.op | required | FilterOperator |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| hl7au-vsd-base-01 | error | ValueSet.version | The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 : matches('^([1-9]{1,2})[.]([0-9]{1}|[1-9]{1}[0-9]{1})[.]([0-9]{1}|[1-9]{1}[0-9]{1})$') | |
| hl7au-vsd-base-02 | error | ValueSet.url, ValueSet.identifier.value | The url starts with 'http://terminology.hl7.org.au/ValueSet/' : startsWith('http://terminology.hl7.org.au/ValueSet/') | |
| hl7au-vsd-base-03 | error | ValueSet.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-vsd-base-04 | error | ValueSet.copyright | The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' : startsWith('HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.') | |
| vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists() | |
| vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists() | |
| vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter : concept.empty() or filter.empty() | |
| vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() | |
| vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true | |
| vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() |
This structure is derived from ValueSet
Differential View
This structure is derived from ValueSet
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems hl7au-vsd-base-05: The url should end with the id value, unless it is an AU extended ValueSet |
| id | 1..1 | id | Logical id of this artifact | |
| meta | 1..1 | Meta | Metadata about the resource | |
| versionId | 0..0 | |||
| lastUpdated | 0..0 | |||
| source | 0..0 | |||
| profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/StructureDefinition/shareablevalueset | |
| security | 0..0 | |||
| tag | 0..0 | |||
| implicitRules | 0..0 | |||
| language | 0..0 | |||
| contained | 0..0 | |||
| url | C | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) hl7au-vsd-base-02: The url starts with 'http://terminology.hl7.org.au/ValueSet/' |
| identifier | 1..1 | Identifier | Additional identifier for the value set (business identifier) | |
| use | 0..0 | |||
| type | 0..0 | |||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| value | C | 1..1 | string | The value that is unique hl7au-vsd-base-02: The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' |
| period | 0..0 | |||
| assigner | 0..0 | |||
| version | C | 1..1 | string | Business version of the value set hl7au-vsd-base-01: The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 |
| name | 1..1 | string | Name for this value set (computer friendly) | |
| title | 1..1 | string | Name for this value set (human friendly) | |
| experimental | 1..1 | boolean | For testing purposes, not real usage | |
| date | 1..1 | dateTime | Date last changed | |
| publisher | C | 1..1 | string | Name of the publisher (organization or individual) hl7au-vsd-base-03: The publisher starts with 'Health Level Seven Australia' |
| contact | 1..1 | ContactDetail | Contact details for the publisher | |
| name | 0..0 | |||
| telecom | 1..1 | ContactPoint | Contact details for individual or organization | |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url | |
| value | 1..1 | string | The actual contact point details Fixed Value: http://hl7.com.au | |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| rank | 0..0 | |||
| period | 0..0 | |||
| description | 1..1 | markdown | Natural language description of the value set | |
| useContext | 0..0 | |||
| jurisdiction | 1..1 | CodeableConcept | Intended jurisdiction for value set (if applicable) | |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
| version | 0..0 | |||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AU | |
| display | 0..0 | |||
| userSelected | 0..0 | |||
| text | 0..0 | |||
| purpose | 0..0 | |||
| copyright | C | 1..1 | markdown | Use and/or publishing restrictions hl7au-vsd-base-04: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| hl7au-vsd-base-01 | error | ValueSet.version | The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 : matches('^([1-9]{1,2})[.]([0-9]{1}|[1-9]{1}[0-9]{1})[.]([0-9]{1}|[1-9]{1}[0-9]{1})$') | |
| hl7au-vsd-base-02 | error | ValueSet.url, ValueSet.identifier.value | The url starts with 'http://terminology.hl7.org.au/ValueSet/' : startsWith('http://terminology.hl7.org.au/ValueSet/') | |
| hl7au-vsd-base-03 | error | ValueSet.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-vsd-base-04 | error | ValueSet.copyright | The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' : startsWith('HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.') | |
| hl7au-vsd-base-05 | warning | ValueSet | The url should end with the id value, unless it is an AU extended ValueSet : url.replace('http://terminology.hl7.org.au/ValueSet/','') = id |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems hl7au-vsd-base-05: The url should end with the id value, unless it is an AU extended ValueSet |
| id | Σ | 1..1 | id | Logical id of this artifact |
| meta | Σ | 1..1 | Meta | Metadata about the resource |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/StructureDefinition/shareablevalueset |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | ΣC | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) hl7au-vsd-base-02: The url starts with 'http://terminology.hl7.org.au/ValueSet/' |
| identifier | Σ | 1..1 | Identifier | Additional identifier for the value set (business identifier) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
| value | ΣC | 1..1 | string | The value that is unique hl7au-vsd-base-02: The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' Example General: 123456 |
| version | ΣC | 1..1 | string | Business version of the value set hl7au-vsd-base-01: The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 |
| name | ΣC | 1..1 | string | Name for this value set (computer friendly) |
| title | Σ | 1..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 | Σ | 1..1 | dateTime | Date last changed |
| publisher | ΣC | 1..1 | string | Name of the publisher (organization or individual) hl7au-vsd-base-03: The publisher starts with 'Health Level Seven Australia' |
| contact | Σ | 1..1 | ContactDetail | Contact details for the publisher |
| telecom | Σ | 1..1 | ContactPoint | Contact details for individual or organization |
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url |
| value | Σ | 1..1 | string | The actual contact point details Fixed Value: http://hl7.com.au |
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
| description | 1..1 | markdown | Natural language description of the value set | |
| jurisdiction | Σ | 1..1 | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AU |
| copyright | C | 1..1 | markdown | Use and/or publishing restrictions hl7au-vsd-base-04: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ValueSet.status | required | PublicationStatus |
| ValueSet.contact.telecom.system | required | Fixed Value: url |
| ValueSet.contact.telecom.use | required | Fixed Value: work |
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSet |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ValueSet | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| hl7au-vsd-base-01 | error | ValueSet.version | The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 : matches('^([1-9]{1,2})[.]([0-9]{1}|[1-9]{1}[0-9]{1})[.]([0-9]{1}|[1-9]{1}[0-9]{1})$') | |
| hl7au-vsd-base-02 | error | ValueSet.url, ValueSet.identifier.value | The url starts with 'http://terminology.hl7.org.au/ValueSet/' : startsWith('http://terminology.hl7.org.au/ValueSet/') | |
| hl7au-vsd-base-03 | error | ValueSet.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-vsd-base-04 | error | ValueSet.copyright | The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' : startsWith('HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.') | |
| hl7au-vsd-base-05 | warning | ValueSet | The url should end with the id value, unless it is an AU extended ValueSet : url.replace('http://terminology.hl7.org.au/ValueSet/','') = id | |
| vsd-0 | warning | 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}') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems hl7au-vsd-base-05: The url should end with the id value, unless it is an AU extended ValueSet | ||||
| id | Σ | 1..1 | id | Logical id of this artifact | ||||
| meta | Σ | 1..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/StructureDefinition/shareablevalueset | ||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | ΣC | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) hl7au-vsd-base-02: The url starts with 'http://terminology.hl7.org.au/ValueSet/' | ||||
| identifier | Σ | 1..1 | Identifier | Additional identifier for the value set (business identifier) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value | ΣC | 1..1 | string | The value that is unique hl7au-vsd-base-02: The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' Example General: 123456 | ||||
| version | ΣC | 1..1 | string | Business version of the value set hl7au-vsd-base-01: The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 | ||||
| name | ΣC | 1..1 | string | Name for this value set (computer friendly) | ||||
| title | Σ | 1..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 | Σ | 1..1 | dateTime | Date last changed | ||||
| publisher | ΣC | 1..1 | string | Name of the publisher (organization or individual) hl7au-vsd-base-03: The publisher starts with 'Health Level Seven Australia' | ||||
| contact | Σ | 1..1 | ContactDetail | Contact details for the publisher | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| telecom | Σ | 1..1 | ContactPoint | Contact details for individual or organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url | ||||
| value | Σ | 1..1 | string | The actual contact point details Fixed Value: http://hl7.com.au | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| description | 1..1 | markdown | Natural language description of the value set | |||||
| jurisdiction | Σ | 1..1 | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AU | ||||
| immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
| copyright | C | 1..1 | markdown | Use and/or publishing restrictions hl7au-vsd-base-04: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' | ||||
| 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) | ||||
| 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.
| |||||
| 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 | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| ValueSet.status | required | PublicationStatus | ||||
| ValueSet.contact.telecom.system | required | Fixed Value: url | ||||
| ValueSet.contact.telecom.use | required | Fixed Value: work | ||||
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
| ||||
| ValueSet.compose.include.concept.designation.use | extensible | DesignationUse | ||||
| ValueSet.compose.include.filter.op | required | FilterOperator |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| hl7au-vsd-base-01 | error | ValueSet.version | The version number is in semantic versioning format ('n.n.n'), with the major version number at least 1 : matches('^([1-9]{1,2})[.]([0-9]{1}|[1-9]{1}[0-9]{1})[.]([0-9]{1}|[1-9]{1}[0-9]{1})$') | |
| hl7au-vsd-base-02 | error | ValueSet.url, ValueSet.identifier.value | The url starts with 'http://terminology.hl7.org.au/ValueSet/' : startsWith('http://terminology.hl7.org.au/ValueSet/') | |
| hl7au-vsd-base-03 | error | ValueSet.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-vsd-base-04 | error | ValueSet.copyright | The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' : startsWith('HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.') | |
| vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists() | |
| vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists() | |
| vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter : concept.empty() or filter.empty() | |
| vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() | |
| vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true | |
| vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() |
This structure is derived from ValueSet
Other representations of profile: CSV, Excel, Schematron