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-csd-1 | Version: 0.0.1 | |||
| Draft as of 2022-03-25 | Computable Name: HL7AUCodeSystemBase | |||
Copyright/Legal: This is free and unencumbered software released into the public domain. |
||||
The purpose of this profile is to enforce conventions for CodeSystems, in metadata and structure
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CodeSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement hl7au-csd-base-05: The url should end with the id value, unless it is an AU extended CodeSystem |
  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/shareablecodesystem | |
| security | 0..0 | |||
 tag | 0..0 | |||
| implicitRules | 0..0 | |||
| language | 0..0 | |||
| contained | 0..0 | |||
| url | C | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) hl7au-csd-base-02: The url starts with 'http://terminology.hl7.org.au/CodeSystem/' |
| identifier | 1..1 | Identifier | Additional identifier for the code system (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-csd-base-03: 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 code system (Coding.version) hl7au-csd-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 code system (computer friendly) | |
| title | 1..1 | string | Name for this code system (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-csd-base-04: 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 code system | |
| useContext | 0..0 | |||
| jurisdiction | 1..1 | CodeableConcept | Intended jurisdiction for code system (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-csd-base-05: 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-csd-base-01 | error | CodeSystem.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-csd-base-02 | error | CodeSystem.url | The url starts with 'http://terminology.hl7.org.au/CodeSystem/' : startsWith('http://terminology.hl7.org.au/CodeSystem/') | |
| hl7au-csd-base-03 | error | CodeSystem.identifier.value | The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' : startsWith('urn:oid:2.16.840.1.113883.2.3.4.') | |
| hl7au-csd-base-04 | error | CodeSystem.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-csd-base-05 | warning | CodeSystem, CodeSystem.copyright | The url should end with the id value, unless it is an AU extended CodeSystem : url.replace('http://terminology.hl7.org.au/CodeSystem/','') = id |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement hl7au-csd-base-05: The url should end with the id value, unless it is an AU extended CodeSystem |
 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/shareablecodesystem |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | ΣC | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) hl7au-csd-base-02: The url starts with 'http://terminology.hl7.org.au/CodeSystem/' |
| identifier | Σ | 1..1 | Identifier | Additional identifier for the code system (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-csd-base-03: 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 code system (Coding.version) hl7au-csd-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 code system (computer friendly) |
| title | Σ | 1..1 | string | Name for this code system (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-csd-base-04: 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 code system | |
| jurisdiction | Σ | 1..1 | CodeableConcept | Intended jurisdiction for code system (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-csd-base-05: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' |
| content | Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| CodeSystem.status | required | PublicationStatus |
| CodeSystem.contact.telecom.system | required | Fixed Value: url |
| CodeSystem.contact.telecom.use | required | Fixed Value: work |
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet |
| CodeSystem.content | required | CodeSystemContentMode |
| Id | Grade | Path(s) | Details | Requirements |
| csd-0 | warning | CodeSystem | 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}') | |
| csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
| dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CodeSystem | 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 | CodeSystem | 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 | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CodeSystem | 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-csd-base-01 | error | CodeSystem.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-csd-base-02 | error | CodeSystem.url | The url starts with 'http://terminology.hl7.org.au/CodeSystem/' : startsWith('http://terminology.hl7.org.au/CodeSystem/') | |
| hl7au-csd-base-03 | error | CodeSystem.identifier.value | The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' : startsWith('urn:oid:2.16.840.1.113883.2.3.4.') | |
| hl7au-csd-base-04 | error | CodeSystem.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-csd-base-05 | warning | CodeSystem, CodeSystem.copyright | The url should end with the id value, unless it is an AU extended CodeSystem : url.replace('http://terminology.hl7.org.au/CodeSystem/','') = id |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement hl7au-csd-base-05: The url should end with the id value, unless it is an AU extended CodeSystem | ||||
| 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/shareablecodesystem | ||||
| 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 code system, represented as a URI (globally unique) (Coding.system) hl7au-csd-base-02: The url starts with 'http://terminology.hl7.org.au/CodeSystem/' | ||||
| identifier | Σ | 1..1 | Identifier | Additional identifier for the code system (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-csd-base-03: 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 code system (Coding.version) hl7au-csd-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 code system (computer friendly) | ||||
| title | Σ | 1..1 | string | Name for this code system (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-csd-base-04: 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 code system | |||||
| jurisdiction | Σ | 1..1 | CodeableConcept | Intended jurisdiction for code system (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 | ||||
| copyright | C | 1..1 | markdown | Use and/or publishing restrictions hl7au-csd-base-05: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' | ||||
| caseSensitive | Σ | 0..1 | boolean | If code comparison is case sensitive | ||||
| valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
| hierarchyMeaning | Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system. | ||||
| compositional | Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
| versionNeeded | Σ | 0..1 | boolean | If definitions are not stable | ||||
| content | Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. | ||||
| supplements | Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to | ||||
| count | Σ | 0..1 | unsignedInt | Total concepts in the code system | ||||
| filter | Σ | 0..* | BackboneElement | Filter that can be used in a 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 | ||||
| code | Σ | 1..1 | code | Code that identifies the filter | ||||
| description | Σ | 0..1 | string | How or why the filter is used | ||||
| operator | Σ | 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 | What to use for the value | ||||
| property | Σ | 0..* | BackboneElement | Additional information supplied about each 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 | ||||
| code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
| uri | Σ | 0..1 | uri | Formal identifier for the property | ||||
| description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
| type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. | ||||
| concept | 0..* | BackboneElement | Concepts in the code 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 that identifies concept | |||||
| display | 0..1 | string | Text to display to the user | |||||
| definition | 0..1 | string | Formal definition | |||||
| designation | 0..* | BackboneElement | Additional representations for the 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 | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
| value | 1..1 | string | The text value for this designation | |||||
| property | 0..* | BackboneElement | Property value for the 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 | ||||
| code | 1..1 | code | Reference to CodeSystem.property.code | |||||
 value[x] | 1..1 | Value of the property for this concept | ||||||
| valueCode | code | |||||||
| valueCoding | Coding | |||||||
| valueString | string | |||||||
| valueInteger | integer | |||||||
| valueBoolean | boolean | |||||||
| valueDateTime | dateTime | |||||||
| valueDecimal | decimal | |||||||
| concept | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| CodeSystem.status | required | PublicationStatus | ||||
| CodeSystem.contact.telecom.system | required | Fixed Value: url | ||||
| CodeSystem.contact.telecom.use | required | Fixed Value: work | ||||
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning | ||||
| CodeSystem.content | required | CodeSystemContentMode | ||||
| CodeSystem.filter.operator | required | FilterOperator | ||||
| CodeSystem.property.type | required | PropertyType | ||||
| CodeSystem.concept.designation.language | preferred | CommonLanguages
| ||||
| CodeSystem.concept.designation.use | extensible | DesignationUse |
| 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-csd-base-01 | error | CodeSystem.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-csd-base-02 | error | CodeSystem.url | The url starts with 'http://terminology.hl7.org.au/CodeSystem/' : startsWith('http://terminology.hl7.org.au/CodeSystem/') | |
| hl7au-csd-base-03 | error | CodeSystem.identifier.value | The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' : startsWith('urn:oid:2.16.840.1.113883.2.3.4.') | |
| hl7au-csd-base-04 | error | CodeSystem.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-csd-base-05 | error | CodeSystem.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.') |
This structure is derived from CodeSystem
Differential View
This structure is derived from CodeSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement hl7au-csd-base-05: The url should end with the id value, unless it is an AU extended CodeSystem |
| 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/shareablecodesystem | |
| security | 0..0 | |||
| tag | 0..0 | |||
| implicitRules | 0..0 | |||
| language | 0..0 | |||
| contained | 0..0 | |||
| url | C | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) hl7au-csd-base-02: The url starts with 'http://terminology.hl7.org.au/CodeSystem/' |
| identifier | 1..1 | Identifier | Additional identifier for the code system (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-csd-base-03: 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 code system (Coding.version) hl7au-csd-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 code system (computer friendly) | |
| title | 1..1 | string | Name for this code system (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-csd-base-04: 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 code system | |
| useContext | 0..0 | |||
| jurisdiction | 1..1 | CodeableConcept | Intended jurisdiction for code system (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-csd-base-05: 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-csd-base-01 | error | CodeSystem.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-csd-base-02 | error | CodeSystem.url | The url starts with 'http://terminology.hl7.org.au/CodeSystem/' : startsWith('http://terminology.hl7.org.au/CodeSystem/') | |
| hl7au-csd-base-03 | error | CodeSystem.identifier.value | The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' : startsWith('urn:oid:2.16.840.1.113883.2.3.4.') | |
| hl7au-csd-base-04 | error | CodeSystem.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-csd-base-05 | warning | CodeSystem, CodeSystem.copyright | The url should end with the id value, unless it is an AU extended CodeSystem : url.replace('http://terminology.hl7.org.au/CodeSystem/','') = id |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement hl7au-csd-base-05: The url should end with the id value, unless it is an AU extended CodeSystem |
| 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/shareablecodesystem |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | ΣC | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) hl7au-csd-base-02: The url starts with 'http://terminology.hl7.org.au/CodeSystem/' |
| identifier | Σ | 1..1 | Identifier | Additional identifier for the code system (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-csd-base-03: 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 code system (Coding.version) hl7au-csd-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 code system (computer friendly) |
| title | Σ | 1..1 | string | Name for this code system (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-csd-base-04: 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 code system | |
| jurisdiction | Σ | 1..1 | CodeableConcept | Intended jurisdiction for code system (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-csd-base-05: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' |
| content | Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| CodeSystem.status | required | PublicationStatus |
| CodeSystem.contact.telecom.system | required | Fixed Value: url |
| CodeSystem.contact.telecom.use | required | Fixed Value: work |
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet |
| CodeSystem.content | required | CodeSystemContentMode |
| Id | Grade | Path(s) | Details | Requirements |
| csd-0 | warning | CodeSystem | 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}') | |
| csd-1 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
| dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | CodeSystem | 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 | CodeSystem | 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 | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | CodeSystem | 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-csd-base-01 | error | CodeSystem.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-csd-base-02 | error | CodeSystem.url | The url starts with 'http://terminology.hl7.org.au/CodeSystem/' : startsWith('http://terminology.hl7.org.au/CodeSystem/') | |
| hl7au-csd-base-03 | error | CodeSystem.identifier.value | The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' : startsWith('urn:oid:2.16.840.1.113883.2.3.4.') | |
| hl7au-csd-base-04 | error | CodeSystem.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-csd-base-05 | warning | CodeSystem, CodeSystem.copyright | The url should end with the id value, unless it is an AU extended CodeSystem : url.replace('http://terminology.hl7.org.au/CodeSystem/','') = id |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement hl7au-csd-base-05: The url should end with the id value, unless it is an AU extended CodeSystem | ||||
| 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/shareablecodesystem | ||||
| 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 code system, represented as a URI (globally unique) (Coding.system) hl7au-csd-base-02: The url starts with 'http://terminology.hl7.org.au/CodeSystem/' | ||||
| identifier | Σ | 1..1 | Identifier | Additional identifier for the code system (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-csd-base-03: 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 code system (Coding.version) hl7au-csd-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 code system (computer friendly) | ||||
| title | Σ | 1..1 | string | Name for this code system (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-csd-base-04: 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 code system | |||||
| jurisdiction | Σ | 1..1 | CodeableConcept | Intended jurisdiction for code system (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 | ||||
| copyright | C | 1..1 | markdown | Use and/or publishing restrictions hl7au-csd-base-05: The copyright starts with 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' | ||||
| caseSensitive | Σ | 0..1 | boolean | If code comparison is case sensitive | ||||
| valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | ||||
| hierarchyMeaning | Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system. | ||||
| compositional | Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
| versionNeeded | Σ | 0..1 | boolean | If definitions are not stable | ||||
| content | Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. | ||||
| supplements | Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to | ||||
| count | Σ | 0..1 | unsignedInt | Total concepts in the code system | ||||
| filter | Σ | 0..* | BackboneElement | Filter that can be used in a 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 | ||||
| code | Σ | 1..1 | code | Code that identifies the filter | ||||
| description | Σ | 0..1 | string | How or why the filter is used | ||||
| operator | Σ | 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 | What to use for the value | ||||
| property | Σ | 0..* | BackboneElement | Additional information supplied about each 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 | ||||
| code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
| uri | Σ | 0..1 | uri | Formal identifier for the property | ||||
| description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
| type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value. | ||||
| concept | 0..* | BackboneElement | Concepts in the code 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 that identifies concept | |||||
| display | 0..1 | string | Text to display to the user | |||||
| definition | 0..1 | string | Formal definition | |||||
| designation | 0..* | BackboneElement | Additional representations for the 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 | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
| value | 1..1 | string | The text value for this designation | |||||
| property | 0..* | BackboneElement | Property value for the 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 | ||||
| code | 1..1 | code | Reference to CodeSystem.property.code | |||||
| value[x] | 1..1 | Value of the property for this concept | ||||||
| valueCode | code | |||||||
| valueCoding | Coding | |||||||
| valueString | string | |||||||
| valueInteger | integer | |||||||
| valueBoolean | boolean | |||||||
| valueDateTime | dateTime | |||||||
| valueDecimal | decimal | |||||||
| concept | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes) | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| CodeSystem.status | required | PublicationStatus | ||||
| CodeSystem.contact.telecom.system | required | Fixed Value: url | ||||
| CodeSystem.contact.telecom.use | required | Fixed Value: work | ||||
| CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning | ||||
| CodeSystem.content | required | CodeSystemContentMode | ||||
| CodeSystem.filter.operator | required | FilterOperator | ||||
| CodeSystem.property.type | required | PropertyType | ||||
| CodeSystem.concept.designation.language | preferred | CommonLanguages
| ||||
| CodeSystem.concept.designation.use | extensible | DesignationUse |
| 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-csd-base-01 | error | CodeSystem.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-csd-base-02 | error | CodeSystem.url | The url starts with 'http://terminology.hl7.org.au/CodeSystem/' : startsWith('http://terminology.hl7.org.au/CodeSystem/') | |
| hl7au-csd-base-03 | error | CodeSystem.identifier.value | The identifier.value starts with 'urn:oid:2.16.840.1.113883.2.3.4.' : startsWith('urn:oid:2.16.840.1.113883.2.3.4.') | |
| hl7au-csd-base-04 | error | CodeSystem.publisher | The publisher starts with 'Health Level Seven Australia' : startsWith('Health Level Seven Australia') | |
| hl7au-csd-base-05 | error | CodeSystem.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.') |
This structure is derived from CodeSystem
Other representations of profile: CSV, Excel, Schematron