R6 Ballot (2nd Draft)

Publish-box (todo)

Example CodeSystem/map-transform (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Code SystemStructureMapTransform

{
  "resourceType" : "CodeSystem",
  "id" : "map-transform",
  "meta" : {
    "lastUpdated" : "2024-08-12T16:52:12.437+08:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem map-transform</b></p><a name=\"map-transform\"> </a><a name=\"hcmap-transform\"> </a><a name=\"map-transform-en-AU\"> </a><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class=\"grid\"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><td>FHIRPath Equivalent</td><td>fhirpath</td><td>string</td><td>FHIRPath equivalent for transform function</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://hl7.org/fhir/map-transform</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Definition</b></td><td><b>FHIRPath Equivalent</b></td></tr><tr><td style=\"white-space:nowrap\">create<a name=\"map-transform-create\"> </a></td><td><div><p>create(type : string) - type is passed through to the application on the standard API, and must be known by it.</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">copy<a name=\"map-transform-copy\"> </a></td><td><div><p>copy(source).</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">truncate<a name=\"map-transform-truncate\"> </a></td><td><div><p>truncate(source, length) - source must be stringy type.</p>\n</div></td><td>substring</td></tr><tr><td style=\"white-space:nowrap\">escape<a name=\"map-transform-escape\"> </a></td><td><div><p>escape(source, fmt1, fmt2) - change source from one kind of escaping to another (plain, java, xml, json). note that this is for when the string itself is escaped.</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">cast<a name=\"map-transform-cast\"> </a></td><td><div><p>cast(source, type?) - cast (convert) source from one type to another. Target type can be left as implicit if there is one and only one target type known. The default namespace for the type is 'FHIR' (see <a href=\"http://hl7.org/fhirpath/N1/#is-type-specifier\">FHIRPath type specifiers</a>)</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">append<a name=\"map-transform-append\"> </a></td><td><div><p>append(source...) - source is element or string.</p>\n</div></td><td>&amp; (String concatenation)</td></tr><tr><td style=\"white-space:nowrap\">translate<a name=\"map-transform-translate\"> </a></td><td><div><p>translate(source, uri_of_map) - use the translate operation.</p>\n</div></td><td>%terminologies.translate()</td></tr><tr><td style=\"white-space:nowrap\">reference<a name=\"map-transform-reference\"> </a></td><td><div><p>reference(source : object) - return a string that references the provided tree properly.</p>\n</div></td><td>related to resolve() but returns the string pointer</td></tr><tr><td style=\"white-space:nowrap\">dateOp<a name=\"map-transform-dateOp\"> </a></td><td><div><p>Perform a date operation. <em>Parameters to be documented</em>.</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">uuid<a name=\"map-transform-uuid\"> </a></td><td><div><p>Generate a random UUID (in lowercase). No Parameters.</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">pointer<a name=\"map-transform-pointer\"> </a></td><td><div><p>Return the appropriate string to put in a reference that refers to the resource provided as a parameter.</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">evaluate<a name=\"map-transform-evaluate\"> </a></td><td><div><p>Execute the supplied FHIRPath expression and use the value returned by that.</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">cc<a name=\"map-transform-cc\"> </a></td><td><div><p>Create a CodeableConcept. Parameters = (text) or (system. Code[, display]).</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">c<a name=\"map-transform-c\"> </a></td><td><div><p>Create a Coding. Parameters = (system. Code[, display]).</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">qty<a name=\"map-transform-qty\"> </a></td><td><div><p>Create a quantity. Parameters = (text) or (value, unit, [system, code]) where text is the natural representation e.g. [comparator]value[space]unit.</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">id<a name=\"map-transform-id\"> </a></td><td><div><p>Create an identifier. Parameters = (system, value[, type]) where type is a code from the identifier type value set.</p>\n</div></td><td>n/a</td></tr><tr><td style=\"white-space:nowrap\">cp<a name=\"map-transform-cp\"> </a></td><td><div><p>Create a contact details. Parameters = (value) or (system, value). If no system is provided, the system should be inferred from the content of the value.</p>\n</div></td><td>n/a</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 2
  }],
  "url" : "http://hl7.org/fhir/map-transform",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.682"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.668"
  }],
  "version" : "6.0.0-ballot2",
  "name" : "StructureMapTransform",
  "title" : "Structure Map Transform",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "How data is copied/created.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/map-transform",
  "content" : "complete",
  "property" : [{
    "code" : "fhirpath",
    "_code" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/rendered-value",
        "valueString" : "FHIRPath Equivalent"
      }]
    },
    "description" : "FHIRPath equivalent for transform function",
    "type" : "string"
  }],
  "concept" : [{
    "code" : "create",
    "display" : "create",
    "definition" : "create(type : string) - type is passed through to the application on the standard API, and must be known by it.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "copy",
    "display" : "copy",
    "definition" : "copy(source).",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "truncate",
    "display" : "truncate",
    "definition" : "truncate(source, length) - source must be stringy type.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "substring"
    }]
  },
  {
    "code" : "escape",
    "display" : "escape",
    "definition" : "escape(source, fmt1, fmt2) - change source from one kind of escaping to another (plain, java, xml, json). note that this is for when the string itself is escaped.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "cast",
    "display" : "cast",
    "definition" : "cast(source, type?) - cast (convert) source from one type to another. Target type can be left as implicit if there is one and only one target type known. The default namespace for the type is 'FHIR' (see [FHIRPath type specifiers](http://hl7.org/fhirpath/N1/#is-type-specifier))",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "append",
    "display" : "append",
    "definition" : "append(source...) - source is element or string.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "& (String concatenation)"
    }]
  },
  {
    "code" : "translate",
    "display" : "translate",
    "definition" : "translate(source, uri_of_map) - use the translate operation.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "%terminologies.translate()"
    }]
  },
  {
    "code" : "reference",
    "display" : "reference",
    "definition" : "reference(source : object) - return a string that references the provided tree properly.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "related to resolve() but returns the string pointer"
    }]
  },
  {
    "code" : "dateOp",
    "display" : "dateOp",
    "definition" : "Perform a date operation. *Parameters to be documented*.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "uuid",
    "display" : "uuid",
    "definition" : "Generate a random UUID (in lowercase). No Parameters.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "pointer",
    "display" : "pointer",
    "definition" : "Return the appropriate string to put in a reference that refers to the resource provided as a parameter.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "evaluate",
    "display" : "evaluate",
    "definition" : "Execute the supplied FHIRPath expression and use the value returned by that.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "cc",
    "display" : "cc",
    "definition" : "Create a CodeableConcept. Parameters = (text) or (system. Code[, display]).",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "c",
    "display" : "c",
    "definition" : "Create a Coding. Parameters = (system. Code[, display]).",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "qty",
    "display" : "qty",
    "definition" : "Create a quantity. Parameters = (text) or (value, unit, [system, code]) where text is the natural representation e.g. [comparator]value[space]unit.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "id",
    "display" : "id",
    "definition" : "Create an identifier. Parameters = (system, value[, type]) where type is a code from the identifier type value set.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  },
  {
    "code" : "cp",
    "display" : "cp",
    "definition" : "Create a contact details. Parameters = (value) or (system, value). If no system is provided, the system should be inferred from the content of the value.",
    "property" : [{
      "code" : "fhirpath",
      "valueString" : "n/a"
    }]
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.