FHIR🔥 API Extensions

ValueSet/$expand R5 features (since V6.3)

The additional parameter property can be supplied to an $expand request to request that the values for specified properties are also returned in the expansion (where they exist). Because there is no element defined in ValueSet.expansion.contains in FHIR R4, the Extension element http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property is used.

An example result looks like:

{
  "resourceType": "ValueSet",
  "expansion": {
    "total": 1,
    "offset": 0,
    "parameter": [{
      "name": "version",
      "valueUri": "https://dmd.nhs.uk|202107.1.0"
    }],
    "contains": [{
      "system": "https://dmd.nhs.uk",
      "code": "318248001",
      "display": "Verapamil 160mg tablets",
      "extension": [{
        "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property",
        "extension": [{
          "url": "code",
          "valueCode": "ROUTECD"
        }, {
          "url": "value",
          "valueCoding": {
            "system": "https://dmd.nhs.uk",
            "code": "26643006"
          }
        }]
      }]
    }]
  }
}