DataElement - FHIR Resource (stu3)
This DataElement Resource uses the FHIR API standard for access and structure.
Validate an DataElement FHIR Resource (stu3)
DataElement Attributes
AttributeField is listTypeDescription
Description: draft | active | retired | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (DataElement) status FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": "DCP"Learn more about the (DataElement) publisher FHIR attribute
Description: comparable | fully-specified | equivalent | convertable | scaleable | flexible
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"stringency": Learn more about the (DataElement) stringency FHIR attribute
Description: Name for this data element (computer friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "Gender Code"Learn more about the (DataElement) name FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (DataElement) copyright FHIR attribute
Description: Name for this data element (human friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": "Administrative gender"Learn more about the (DataElement) title FHIR attribute
Description: Logical URI to reference this data element (globally unique)
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (DataElement) url FHIR attribute
Description: Intended jurisdiction for data element (if applicable)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": [
{
"coding": [
{
"code": "US",
"system": "urn:iso:std:iso:3166"
}
]
}
]Learn more about the (DataElement) jurisdiction FHIR attribute
Description: C? External specification mapped to
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"mapping": [
{
"uri": "http://hl7.org/fhir/api",
"identity": "fhir",
"name": "Fast Healthcare Interoperable Resources (FHIR)"
}
]Learn more about the (DataElement) mapping FHIR attribute
Description: Definition of element
FHIR Version: stu3
Attribute Type : ElementDefinition
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
]
}
]Learn more about the (DataElement) element FHIR attribute
Description: Contact details for the publisher
FHIR Version: stu3
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (DataElement) contact FHIR attribute
Description: Context the content is intended to support
FHIR Version: stu3
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (DataElement) useContext FHIR attribute
Description: Business version of the data element
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": "1.0"Learn more about the (DataElement) version FHIR attribute
Description: Date this was last changed
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2016-01-01"Learn more about the (DataElement) date FHIR attribute
Description: Additional identifier for the data element
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"value": "2179650"
}
]Learn more about the (DataElement) identifier FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (DataElement) experimental FHIR attribute
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 them like so:
https://api.1up.health/fhir/stu3/DataElement?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
code | text | element.code |
date | date | date |
description | text | element.definition |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
name | text | name |
publisher | text | publisher |
status | text | status |
stringency | text | stringency |
title | text | title |
url | uri | url |
version | text | version |
