# NCTS Composed Value Set - Medtech ALEX® AU Implementation Guide v1.0.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **NCTS Composed Value Set**

## Resource Profile: NCTS Composed Value Set 

| | |
| :--- | :--- |
| *Official URL*:https://healthterminologies.gov.au/fhir/StructureDefinition/composed-value-set-4 | *Version*:1.0.0 |
| Active as of 2023-07-31 | *Computable Name*:Ncts_composed_value_set |

 
This StructureDefinition describes the NCTS Composed Value Set, a profile of the FHIR® ValueSet resource. The NCTS Composed Value Set is designed to represent value sets published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem. 

 
The purpose of this profile is to codify a set of general best practices with respect to representing value sets in FHIR, and an opinionated approach to versioning that is compatible with the syndication model that NCTS uses. 

**Usages:**

* Examples for this Profile: [AustralianIndigenousStatus](ValueSet-australian-indigenous-status-1.md), [AustralianMedication](ValueSet-australian-medication-1.md), [AustralianStatesAndTerritories](ValueSet-australian-states-territories-2.md), [ContactRelationshipType](ValueSet-contact-relationship-type-3.md)...Show 6 more,[IndividualHealthcareIdentifierRecordStatus](ValueSet-ihi-record-status-1.md),[IndividualHealthcareIdentifierStatus](ValueSet-ihi-status-1.md),[MedicationReasonTaken](ValueSet-medication-reason-taken-1.md),[MedicineSubstitutionReason](ValueSet-medicine-substitution-reason-1.md),[ReasonForRequest](ValueSet-reason-for-request-1.md)and[RouteOfAdministration](ValueSet-route-of-administration-1.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/medtechglobal.fhir.alex|current/StructureDefinition/composed-value-set-4)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-composed-value-set-4.csv), [Excel](StructureDefinition-composed-value-set-4.xlsx), [Schematron](StructureDefinition-composed-value-set-4.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "composed-value-set-4",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2024-09-25T22:35:19.027+00:00"
  },
  "url" : "https://healthterminologies.gov.au/fhir/StructureDefinition/composed-value-set-4",
  "version" : "1.0.0",
  "name" : "Ncts_composed_value_set",
  "title" : "NCTS Composed Value Set",
  "status" : "active",
  "date" : "2023-07-31T00:00:00+10:00",
  "publisher" : "Medtech Global",
  "contact" : [
    {
      "name" : "Medtech Global",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://medtechglobal.com/au/"
        },
        {
          "system" : "email",
          "value" : "supportau@medtechglobal.com"
        }
      ]
    },
    {
      "name" : "Medtech Support",
      "telecom" : [
        {
          "system" : "email",
          "value" : "supportau@medtechglobal.com",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "This StructureDefinition describes the NCTS Composed Value Set, a profile of the FHIR&reg; ValueSet resource. The NCTS Composed Value Set is designed to represent value sets published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "purpose" : "The purpose of this profile is to codify a set of general best practices with respect to representing value sets in FHIR, and an opinionated approach to versioning that is compatible with the syndication model that NCTS uses.",
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    },
    {
      "identity" : "workflow",
      "uri" : "http://hl7.org/fhir/workflow",
      "name" : "Workflow Pattern"
    },
    {
      "identity" : "w5",
      "uri" : "http://hl7.org/fhir/fivews",
      "name" : "FiveWs Pattern Mapping"
    },
    {
      "identity" : "objimpl",
      "uri" : "http://hl7.org/fhir/object-implementation",
      "name" : "Object Implementation Information"
    }
  ],
  "kind" : "resource",
  "abstract" : false,
  "type" : "ValueSet",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/ValueSet",
  "derivation" : "constraint",
  "differential" : {
    "element" : [
      {
        "id" : "ValueSet",
        "path" : "ValueSet"
      },
      {
        "id" : "ValueSet.implicitRules",
        "path" : "ValueSet.implicitRules",
        "definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.text",
        "path" : "ValueSet.text",
        "definition" : "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
        "min" : 1
      },
      {
        "id" : "ValueSet.contained",
        "path" : "ValueSet.contained",
        "definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.modifierExtension",
        "path" : "ValueSet.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.url",
        "path" : "ValueSet.url",
        "definition" : "An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).",
        "min" : 1
      },
      {
        "id" : "ValueSet.identifier",
        "path" : "ValueSet.identifier",
        "definition" : "A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.",
        "min" : 1
      },
      {
        "id" : "ValueSet.identifier.system",
        "path" : "ValueSet.identifier.system",
        "definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
        "min" : 1,
        "fixedUri" : "urn:ietf:rfc:3986"
      },
      {
        "id" : "ValueSet.identifier.value",
        "path" : "ValueSet.identifier.value",
        "definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
        "min" : 1
      },
      {
        "id" : "ValueSet.version",
        "path" : "ValueSet.version",
        "definition" : "The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
        "min" : 1
      },
      {
        "id" : "ValueSet.name",
        "path" : "ValueSet.name",
        "definition" : "A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
        "min" : 1
      },
      {
        "id" : "ValueSet.title",
        "path" : "ValueSet.title",
        "definition" : "A short, descriptive, user-friendly title for the value set.",
        "min" : 1
      },
      {
        "id" : "ValueSet.experimental",
        "path" : "ValueSet.experimental",
        "definition" : "A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
        "min" : 1
      },
      {
        "id" : "ValueSet.date",
        "path" : "ValueSet.date",
        "definition" : "The date  (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the 'content logical definition').",
        "min" : 1
      },
      {
        "id" : "ValueSet.publisher",
        "path" : "ValueSet.publisher",
        "definition" : "The name of the individual or organization that published the value set.",
        "min" : 1
      },
      {
        "id" : "ValueSet.contact.name",
        "path" : "ValueSet.contact.name",
        "definition" : "The name of an individual to contact.",
        "min" : 0,
        "max" : "1"
      },
      {
        "id" : "ValueSet.contact.telecom",
        "path" : "ValueSet.contact.telecom",
        "definition" : "The contact details for the individual (if a name was provided) or the organization.",
        "min" : 1
      },
      {
        "id" : "ValueSet.description",
        "path" : "ValueSet.description",
        "definition" : "A free text natural language description of the value set from a consumer's perspective.",
        "min" : 1
      },
      {
        "id" : "ValueSet.immutable",
        "path" : "ValueSet.immutable",
        "definition" : "If this is set to 'true', then no new versions of the content logical definition can be created.  Note: Other metadata might still change.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.copyright",
        "path" : "ValueSet.copyright",
        "definition" : "A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.",
        "min" : 1
      },
      {
        "id" : "ValueSet.compose",
        "path" : "ValueSet.compose",
        "definition" : "A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the \"Content Logical Definition\" (CLD).",
        "min" : 1
      },
      {
        "id" : "ValueSet.compose.modifierExtension",
        "path" : "ValueSet.compose.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.compose.lockedDate",
        "path" : "ValueSet.compose.lockedDate",
        "definition" : "If a locked date is defined, then the Content Logical Definition must be evaluated using the current version as of the locked date for referenced code system(s) and value set instances where ValueSet.compose.include.version is not defined.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.compose.include.modifierExtension",
        "path" : "ValueSet.compose.include.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.compose.include.concept.modifierExtension",
        "path" : "ValueSet.compose.include.concept.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.compose.include.concept.designation.modifierExtension",
        "path" : "ValueSet.compose.include.concept.designation.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.compose.include.filter.modifierExtension",
        "path" : "ValueSet.compose.include.filter.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.expansion",
        "path" : "ValueSet.expansion",
        "definition" : "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.expansion.modifierExtension",
        "path" : "ValueSet.expansion.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.expansion.parameter.modifierExtension",
        "path" : "ValueSet.expansion.parameter.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      },
      {
        "id" : "ValueSet.expansion.contains.modifierExtension",
        "path" : "ValueSet.expansion.contains.modifierExtension",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
        "max" : "0"
      }
    ]
  }
}

```
