This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/dataelement-sdc-sdcelement
Sets expectations for data elements registered or used as part of the structured data capture project
This profile was published on Mon, Apr 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC)'s Standards and Infrastructure (S&I) Structured Data Capture project.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from DataElement.
Summary
Mandatory: 7 elements, Must-Support: 57 elements, Fixed Value: 1 element, Prohibited: 12 elements
Extensions
This structure refers to these extensions:
This structure is derived from DataElement.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DataElement | 1..1 | DataElement | ||
url | S | |||
identifier | S | 1..1 | ||
version | S | |||
name | S | 1..1 | ||
useContext | S | |||
experimental | S | |||
status | S | |||
date | S | |||
copyright | S | |||
publisher | S | string | ||
contact | S | |||
telecom | S | |||
specificity | S | 1..1 | ||
mapping | S I | inv-1: Property extension can only be specified if ObjectClass extension is present | ||
identity | S | |||
uri | S | |||
name | S | |||
comments | S | |||
element | S | |||
path | S | |||
name | S | |||
label | S | |||
code | S | |||
definition | S | 1..1 | ||
comments | S | |||
requirements | S | |||
alias | S | 0..* | ||
min | S | 0..0 | ||
max | S | 0..0 | ||
type | S | 0..1 | ||
code | S | |||
defaultValue[x] | 0..0 | |||
meaningWhenMissing | 0..0 | |||
example[x] | S | |||
maxLength | S | |||
condition | S | 0..0 | ||
constraint | S | 0..0 | ||
mustSupport | 0..0 | |||
binding | S | |||
name | S | |||
strength | S | |||
description | S | |||
valueSetReference | S | 1..1 | ValueSet | |
mapping | S | |||
language | S | Binding: DEXMappingLanguage (extensible) | ||
map | S | This should be expressed as "[uri for object class code system]#[code for object class code system] | [uri for property code system]#[code for property code system]". | ||
elementdefinition-equivalence | S | 1..1 | code | equivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint |
valueCode | 1..1 | code | Fixed Value: equivalent | |
minLength | S | 0..1 | integer | At least this many characters |
regex | S | 0..1 | string | Regular expression pattern |
entryFormat | S | 0..1 | string | User prompt for format |
minValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be >= this value |
maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value |
maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal |
elementdefinition-question | S | 0..* | string | Prompt for element phrased as question |
elementdefinition-allowedUnits | S | 0..1 | CodeableConcept, ValueSet | Units to use for measured value |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DataElement | 1..1 | DataElement | Resource data element | |
meta | 0..1 | Meta | Metadata about the resource | |
implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Language (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | S Σ | 0..1 | uri | Globally unique logical id for data element |
identifier | S Σ | 1..1 | Identifier | Logical id to reference this data element |
version | S Σ | 0..1 | string | Logical id for this version of the data element |
name | S Σ | 1..1 | string | Descriptive label for this element definition |
useContext | S Σ | 0..* | CodeableConcept | Content intends to support these contexts Binding: ConformanceUseContext (extensible) |
experimental | S Σ | 0..1 | boolean | If for testing purposes, not real usage |
status | ?! SΣ | 1..1 | code | draft | active | retired Binding: ConformanceResourceStatus (required) |
date | S Σ | 0..1 | dateTime | Date for this version of the data element |
copyright | S | 0..1 | string | Use and/or Publishing restrictions |
publisher | S Σ | 0..1 | string | Name of the publisher (Organization or individual) |
contact | S Σ | 0..* | Contact details of the publisher | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
name | Σ | 0..1 | string | Name of a individual to contact |
telecom | S Σ | 0..* | ContactPoint | Contact details for individual or publisher |
specificity | S Σ | 1..1 | code | comparable | fully-specified | equivalent | convertable | scaleable | flexible Binding: DataElementSpecificity (required) |
mapping | S I | 0..* | External specification mapped to inv-1: Property extension can only be specified if ObjectClass extension is present | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identity | S | 1..1 | id | Internal id when this mapping is used |
uri | S | 0..1 | uri | Identifies what this mapping refers to |
name | S | 0..1 | string | Names what this mapping refers to |
comments | S | 0..1 | string | Versions, Issues, Scope limitations etc |
element | S | 1..* | ElementDefinition | Definition of element |
todo
This structure is derived from DataElement.
Summary
Mandatory: 7 elements, Must-Support: 57 elements, Fixed Value: 1 element, Prohibited: 12 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from DataElement.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DataElement | 1..1 | DataElement | ||
url | S | |||
identifier | S | 1..1 | ||
version | S | |||
name | S | 1..1 | ||
useContext | S | |||
experimental | S | |||
status | S | |||
date | S | |||
copyright | S | |||
publisher | S | string | ||
contact | S | |||
telecom | S | |||
specificity | S | 1..1 | ||
mapping | S I | inv-1: Property extension can only be specified if ObjectClass extension is present | ||
identity | S | |||
uri | S | |||
name | S | |||
comments | S | |||
element | S | |||
path | S | |||
name | S | |||
label | S | |||
code | S | |||
definition | S | 1..1 | ||
comments | S | |||
requirements | S | |||
alias | S | 0..* | ||
min | S | 0..0 | ||
max | S | 0..0 | ||
type | S | 0..1 | ||
code | S | |||
defaultValue[x] | 0..0 | |||
meaningWhenMissing | 0..0 | |||
example[x] | S | |||
maxLength | S | |||
condition | S | 0..0 | ||
constraint | S | 0..0 | ||
mustSupport | 0..0 | |||
binding | S | |||
name | S | |||
strength | S | |||
description | S | |||
valueSetReference | S | 1..1 | ValueSet | |
mapping | S | |||
language | S | Binding: DEXMappingLanguage (extensible) | ||
map | S | This should be expressed as "[uri for object class code system]#[code for object class code system] | [uri for property code system]#[code for property code system]". | ||
elementdefinition-equivalence | S | 1..1 | code | equivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint |
valueCode | 1..1 | code | Fixed Value: equivalent | |
minLength | S | 0..1 | integer | At least this many characters |
regex | S | 0..1 | string | Regular expression pattern |
entryFormat | S | 0..1 | string | User prompt for format |
minValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be >= this value |
maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value |
maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal |
elementdefinition-question | S | 0..* | string | Prompt for element phrased as question |
elementdefinition-allowedUnits | S | 0..1 | CodeableConcept, ValueSet | Units to use for measured value |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DataElement | 1..1 | DataElement | Resource data element | |
meta | 0..1 | Meta | Metadata about the resource | |
implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Language (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | S Σ | 0..1 | uri | Globally unique logical id for data element |
identifier | S Σ | 1..1 | Identifier | Logical id to reference this data element |
version | S Σ | 0..1 | string | Logical id for this version of the data element |
name | S Σ | 1..1 | string | Descriptive label for this element definition |
useContext | S Σ | 0..* | CodeableConcept | Content intends to support these contexts Binding: ConformanceUseContext (extensible) |
experimental | S Σ | 0..1 | boolean | If for testing purposes, not real usage |
status | ?! SΣ | 1..1 | code | draft | active | retired Binding: ConformanceResourceStatus (required) |
date | S Σ | 0..1 | dateTime | Date for this version of the data element |
copyright | S | 0..1 | string | Use and/or Publishing restrictions |
publisher | S Σ | 0..1 | string | Name of the publisher (Organization or individual) |
contact | S Σ | 0..* | Contact details of the publisher | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
name | Σ | 0..1 | string | Name of a individual to contact |
telecom | S Σ | 0..* | ContactPoint | Contact details for individual or publisher |
specificity | S Σ | 1..1 | code | comparable | fully-specified | equivalent | convertable | scaleable | flexible Binding: DataElementSpecificity (required) |
mapping | S I | 0..* | External specification mapped to inv-1: Property extension can only be specified if ObjectClass extension is present | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identity | S | 1..1 | id | Internal id when this mapping is used |
uri | S | 0..1 | uri | Identifies what this mapping refers to |
name | S | 0..1 | string | Names what this mapping refers to |
comments | S | 0..1 | string | Versions, Issues, Scope limitations etc |
element | S | 1..* | ElementDefinition | Definition of element |
XML Template
JSON Template
todo
Other representations of profile: (todo)
Path | Name | Conformance | ValueSet |
DataElement.language | Language | required | http://tools.ietf.org/html/bcp47 |
DataElement.useContext | ConformanceUseContext | extensible | Context of Use ValueSet |
DataElement.status | ConformanceResourceStatus | required | ConformanceResourceStatus |
DataElement.specificity | DataElementSpecificity | required | DataElementSpecificity |
Id | Path | Name | Details |
inv-1 | DataElement.mapping | Property extension can only be specified if ObjectClass extension is present XPath: exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-property'])) |