ValueSet.compose

FHIR attribute (r4)

In the ValueSet resource for FHIR r4 , the compose attribute identifies the Content logical definition of the value set (CLD)

compose (ValueSet) description

Resource Type: ValueSet

Attribute Name: compose

Description: Content logical definition of the value set (CLD)

FHIR Version: r4

Attribute Type :

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

ValueSet.compose Example

"compose": {
  "lockedDate": "2012-06-13",
  "inactive": true,
  "include": [
    {
      "system": "http://loinc.org",
      "version": "2.36",
      "concept": [
        {
          "code": "14647-2",
          "display": "Cholesterol [Moles/Volume]"
        },
        {
          "code": "2093-3",
          "display": "Cholesterol [Mass/Volume]"
        },
        {
          "code": "35200-5",
          "display": "Cholesterol [Mass Or Moles/Volume]"
        },
        {
          "code": "9342-7",
          "display": "Cholesterol [Percentile]"
        }
      ]
    }
  ]
}

ValueSet attributes

AttributeField is listTypeDescription

Description: Canonical identifier for this value set, represented as a URI (globally unique)

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url": "http://hl7.org/fhir/ValueSet/example-extensional"

Learn more about the (ValueSet) url FHIR attribute

Description: Additional identifier for the value set (business identifier)

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://acme.com/identifiers/valuesets",
    "value": "loinc-cholesterol-int"
  }
]

Learn more about the (ValueSet) identifier FHIR attribute

Description: Business version of the value set

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version": "20150622"

Learn more about the (ValueSet) version FHIR attribute

Description: C? Name for this value set (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "LOINC Codes for Cholesterol in Serum/Plasma"

Learn more about the (ValueSet) name FHIR attribute

Description: Name for this value set (human friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"title":

Learn more about the (ValueSet) title FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (ValueSet) status FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental": true

Learn more about the (ValueSet) experimental FHIR attribute

Description: Date last changed

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2015-06-22"

Learn more about the (ValueSet) date FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher": "HL7 International"

Learn more about the (ValueSet) publisher FHIR attribute

Description: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "name": "FHIR project team",
    "telecom": [
      {
        "system": "url",
        "value": "http://hl7.org/fhir"
      }
    ]
  }
]

Learn more about the (ValueSet) contact FHIR attribute

Description: Natural language description of the value set

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description": "This is an example value set that includes all the LOINC codes for serum/plasma cholesterol from v2.36."

Learn more about the (ValueSet) description FHIR attribute

Description: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext": [
  {
    "code": {
      "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
      "code": "age"
    },
    "valueQuantity": {
      "value": 18,
      "comparator": ">",
      "unit": "yrs",
      "system": "http://unitsofmeasure.org",
      "code": "a"
    }
  }
]

Learn more about the (ValueSet) useContext FHIR attribute

Description: Intended jurisdiction for value set (if applicable)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction": [
  {
    "coding": [
      {
        "system": "urn:iso:std:iso:3166",
        "code": "US"
      }
    ]
  }
]

Learn more about the (ValueSet) jurisdiction FHIR attribute

Description: Indicates whether or not any change to the content logical definition may occur

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"immutable":

Learn more about the (ValueSet) immutable FHIR attribute

Description: Why this value set is defined

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose": "This value set was published by ACME Inc in order to make clear which codes are used for Cholesterol by AcmeClinicals (Adult Ambulatory care support in USA)"

Learn more about the (ValueSet) purpose FHIR attribute

Description: Use and/or publishing restrictions

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"copyright": "This content from LOINC ® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use."

Learn more about the (ValueSet) copyright FHIR attribute

Description: Content logical definition of the value set (CLD)

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"compose": {
  "lockedDate": "2012-06-13",
  "inactive": true,
  "include": [
    {
      "system": "http://loinc.org",
      "version": "2.36",
      "concept": [
        {
          "code": "14647-2",
          "display": "Cholesterol [Moles/Volume]"
        },
        {
          "code": "2093-3",
          "display": "Cholesterol [Mass/Volume]"
        },
        {
          "code": "35200-5",
          "display": "Cholesterol [Mass Or Moles/Volume]"
        },
        {
          "code": "9342-7",
          "display": "Cholesterol [Percentile]"
        }
      ]
    }
  ]
}

Learn more about the (ValueSet) compose FHIR attribute

Description: Used when the value set is "expanded"

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"expansion":

Learn more about the (ValueSet) expansion FHIR attribute