FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R3 R2

Dataelement-example.json

Orders and Observations Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Not linked to any defined compartments

Raw JSON (canonical form)

Patient gender represented as an data element

{
  "resourceType": "DataElement",
  "id": "gender",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>\n\t\t\t\t<b>Gender Code</b>: The code representing the gender of a person\n      </p>\n\t\t\t<table>\n\t\t\t\t<tbody>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<th>Code</th>\n\t\t\t\t\t\t<th>Display</th>\n\t\t\t\t\t\t<th>Definition</th>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>0</td>\n\t\t\t\t\t\t<td>Unknown</td>\n\t\t\t\t\t\t<td>Not known, not observed, not recorded, or refused.</td>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>1</td>\n\t\t\t\t\t\t<td>Male</td>\n\t\t\t\t\t\t<td>A person who belongs to the sex that normally produces sperm. The term is used to indicate biological sex distinctions, cultural gender role distinctions, or both.</td>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>2</td>\n\t\t\t\t\t\t<td>Female</td>\n\t\t\t\t\t\t<td>A person who belongs to the sex that normally produces ova. The term is used to indicate biological sex distinctions, or cultural gender role distinctions, or both.</td>\n\t\t\t\t\t</tr>\n\t\t\t\t\t<tr>\n\t\t\t\t\t\t<td>3</td>\n\t\t\t\t\t\t<td>Not specified</td>\n\t\t\t\t\t\t<td>Not specified</td>\n\t\t\t\t\t</tr>\n\t\t\t\t</tbody>\n\t\t\t</table>\n\t\t\t<ul>\n\t\t\t\t<li/>\n\t\t\t</ul>\n\t\t</div>"
  },
  "contained": [
    {
      "resourceType": "ValueSet",
      "id": "2179414",
      "url": "http://example.org/2179414",
      "version": "1.0",
      "name": "Gender Code",
      "status": "active",
      "description": "All codes representing the gender of a person.",
      "compose": {
        "include": [
          {
            "system": "http://example.ncit.nci.nih.gov",
            "concept": [
              {
                "code": "C17998",
                "display": "Unknown"
              },
              {
                "code": "C20197",
                "display": "Male"
              },
              {
                "code": "C16576",
                "display": "Female"
              },
              {
                "code": "C38046",
                "display": "Not specified"
              }
            ]
          }
        ]
      }
    },
    {
      "resourceType": "ValueSet",
      "id": "2179414-permitted",
      "status": "active",
      "compose": {
        "include": [
          {
            "system": "http://example.org/fhir/2179414"
          }
        ]
      }
    },
    {
      "resourceType": "ConceptMap",
      "id": "2179414-cm",
      "status": "active",
      "sourceReference": {
        "reference": "#2179414"
      },
      "targetReference": {
        "reference": "#2179414-permitted"
      },
      "group": [
        {
          "source": "http://example.org/fhir/2179414",
          "target": "http://example.org/fhir/2179414",
          "element": [
            {
              "code": "C17998",
              "target": [
                {
                  "code": "0",
                  "equivalence": "equal"
                }
              ]
            },
            {
              "code": "C20197",
              "target": [
                {
                  "code": "1",
                  "equivalence": "equal"
                }
              ]
            },
            {
              "code": "C16576",
              "target": [
                {
                  "code": "2",
                  "equivalence": "equal"
                }
              ]
            },
            {
              "code": "C38046",
              "target": [
                {
                  "code": "3",
                  "equivalence": "equal"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "identifier": [
    {
      "value": "2179650"
    }
  ],
  "version": "1.0",
  "status": "active",
  "date": "2016-01-01",
  "publisher": "DCP",
  "name": "Gender Code",
  "title": "Administrative gender",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "mapping": [
    {
      "identity": "fhir",
      "uri": "http://hl7.org/fhir/api",
      "name": "Fast Healthcare Interoperable Resources (FHIR)"
    }
  ],
  "element": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/minLength",
          "valueInteger": 1
        },
        {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-question",
          "valueString": "Gender"
        }
      ],
      "path": "Gender",
      "code": [
        {
          "system": "http://loinc.org",
          "code": "46098-0",
          "display": "Sex"
        }
      ],
      "definition": "The code representing the gender of a person.",
      "type": [
        {
          "code": "CodeableConcept"
        }
      ],
      "maxLength": 13,
      "binding": {
        "strength": "required",
        "valueSetReference": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset",
              "valueReference": {
                "reference": "#2179414-permitted"
              }
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
              "valueReference": {
                "reference": "#2179414-cm"
              }
            }
          ],
          "reference": "#2179414"
        }
      },
      "mapping": [
        {
          "identity": "fhir",
          "language": "application/xquery",
          "map": "return f:/Patient/f:gender"
        }
      ]
    }
  ]
}

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.