DataElement - FHIR Resource (stu3)


This DataElement Resource uses the FHIR API standard for access and structure.

Validate an DataElement FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
contacttrueContactDetail# Contact details for the publisher
copyrightfalsemarkdown# Use and/or publishing restrictions
datefalsedateTime# Date this was last changed
elementtrueElementDefinition# Definition of element
experimentalfalseboolean# For testing purposes, not real usage
identifiertrueIdentifier# Additional identifier for the data element
jurisdictiontrueCodeableConcept# Intended jurisdiction for data element (if applicable)
mappingtrueData Type# C? External specification mapped to
namefalsestring# Name for this data element (computer friendly)
publisherfalsestring# Name of the publisher (organization or individual)
statusfalsecode# draft | active | retired | unknown
stringencyfalsecode# comparable | fully-specified | equivalent | convertable | scaleable | flexible
titlefalsestring# Name for this data element (human friendly)
urlfalseuri# Logical URI to reference this data element (globally unique)
useContexttrueUsageContext# Context the content is intended to support
versionfalsestring# Business version of the data element

DataElement Example

{
  "status": "active",
  "publisher": "DCP",
  "name": "Gender Code",
  "title": "Administrative gender",
  "resourceType": "DataElement",
  "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>"
  },
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "US",
          "system": "urn:iso:std:iso:3166"
        }
      ]
    }
  ],
  "mapping": [
    {
      "uri": "http://hl7.org/fhir/api",
      "identity": "fhir",
      "name": "Fast Healthcare Interoperable Resources (FHIR)"
    }
  ],
  "element": [
    {
      "definition": "The code representing the gender of a person.",
      "code": [
        {
          "code": "46098-0",
          "system": "http://loinc.org",
          "display": "Sex"
        }
      ],
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/minLength",
          "valueInteger": 1
        },
        {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-question",
          "valueString": "Gender"
        }
      ],
      "binding": {
        "strength": "required",
        "valueSetReference": {
          "reference": "#2179414",
          "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"
              }
            }
          ]
        }
      },
      "mapping": [
        {
          "map": "return f:/Patient/f:gender",
          "language": "application/xquery",
          "identity": "fhir"
        }
      ],
      "maxLength": 13,
      "path": "Gender",
      "type": [
        {
          "code": "CodeableConcept"
        }
      ]
    }
  ],
  "contained": [
    {
      "status": "active",
      "compose": {
        "include": [
          {
            "concept": [
              {
                "code": "C17998",
                "display": "Unknown"
              },
              {
                "code": "C20197",
                "display": "Male"
              },
              {
                "code": "C16576",
                "display": "Female"
              },
              {
                "code": "C38046",
                "display": "Not specified"
              }
            ],
            "system": "http://example.ncit.nci.nih.gov"
          }
        ]
      },
      "name": "Gender Code",
      "resourceType": "ValueSet",
      "url": "http://example.org/2179414",
      "version": "1.0",
      "id": "2179414",
      "description": "All codes representing the gender of a person."
    },
    {
      "resourceType": "ValueSet",
      "status": "active",
      "compose": {
        "include": [
          {
            "system": "http://example.org/fhir/2179414"
          }
        ]
      },
      "id": "2179414-permitted"
    },
    {
      "status": "active",
      "group": [
        {
          "source": "http://example.org/fhir/2179414",
          "target": "http://example.org/fhir/2179414",
          "element": [
            {
              "code": "C17998",
              "target": [
                {
                  "equivalence": "equal",
                  "code": "0"
                }
              ]
            },
            {
              "code": "C20197",
              "target": [
                {
                  "equivalence": "equal",
                  "code": "1"
                }
              ]
            },
            {
              "code": "C16576",
              "target": [
                {
                  "equivalence": "equal",
                  "code": "2"
                }
              ]
            },
            {
              "code": "C38046",
              "target": [
                {
                  "equivalence": "equal",
                  "code": "3"
                }
              ]
            }
          ]
        }
      ],
      "resourceType": "ConceptMap",
      "targetReference": {
        "reference": "#2179414-permitted"
      },
      "sourceReference": {
        "reference": "#2179414"
      },
      "id": "2179414-cm"
    }
  ],
  "version": "1.0",
  "date": "2016-01-01",
  "identifier": [
    {
      "value": "2179650"
    }
  ],
  "id": "gender"
}

DataElement Structure


  
{
  "resourceType" : "DataElement",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this data element (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the data element
  "version" : "<string>", // Business version of the data element
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "name" : "<string>", // Name for this data element (computer friendly)
  "title" : "<string>", // Name for this data element (human friendly)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for data element (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "stringency" : "<code>", // comparable | fully-specified | equivalent | convertable | scaleable | flexible
  "mapping" : [{ // C? External specification mapped to
    "identity" : "<id>", // R!  Internal id when this mapping is used
    "uri" : "<uri>", // Identifies what this mapping refers to
    "name" : "<string>", // Names what this mapping refers to
    "comment" : "<string>" // Versions, issues, scope limitations, etc.
  }],
  "element" : [{ ElementDefinition }] // R!  Definition of element
}


 

DataElement Search Parameters

The following search parameters can be used to query DataElement resources. Just submit the like so:

https://api.1up.health/fhir/stu3/DataElement?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextelement.code
datedatedate
descriptiontextelement.definition
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
statustextstatus
stringencytextstringency
titletexttitle
urluriurl
versiontextversion