2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: SDCElement

The official URL for this profile is: 

http://hl7.org/fhir/Profile/dataelement-sdc-de-sdcelement

. Sets expectations for data elements exchanged or maintained within data element registries according to requirements established by the structured data capture project : Structured Data Capture Data Element Exchange

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.

unable to summarise extension (wrong count)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Differential View

This structure is derived from DataElement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I1..1inv-2: Must have either a code or an object-property mapping from the SDC value set
... telecom S0..*ContactPoint
... identifier S1..1Identifier
... version S0..1string
... publisher S0..1string
... status S1..1code
... date S0..1dateTime
... name S1..1string
... category S0..*CodeableConcept
... granularity S1..1codeBinding: ComparableGranularity (required, not extensible)
... code S I0..1CodingA code that defines the data element in terms of SDC's data element concept value set.
... question S0..1string
... label S0..1string
... definition S1..1string
... comments S0..1string
... requirements S0..1string
... synonym S0..*string
... type S1..1code
... example[x] 0..1*
... maxLength S0..1integer
... units[x] S0..1CodeableConcept, ValueSet
... binding S0..1
.... isExtensible S1..1boolean
.... conformance S0..1code
.... description 0..1string
.... valueSet S1..1ValueSet
... mapping Slice: Unordered, Open, by uri
... mapping S I0..1A mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.
inv-1: Property extension can only be specified if ObjectClass extension is present
.... uri S1..1uriFixed Value: http://healthit.gov/sdc/objectclassproperty
.... definitional S0..1boolean
.... name S0..1string
.... comments S0..1string
.... map S1..1stringThis 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]".
.... 11179-objectClass S I1..1CodingObject Class
..... valueCoding S1..1CodingBinding: SDCObjectClass (required, extensible)
.... 11179-property S I1..1CodingObject Class Property
..... valueCoding S1..1CodingBinding: SDCObjectClassProperty (required, extensible)
... minLength S0..1integerAt least this many characters
... maxLength S0..1integerNo more than this many characters
... regex S0..1stringRegular expression pattern
... entryFormat S0..1stringUser prompt for format
... minValue S0..1date, dateTime, time, instant, decimal, integerMust be >= this value
... maxValue S0..1date, dateTime, time, instant, decimal, integerMust be <= this value
... maxDecimalPlaces S0..1integerMaximum digits after decimal
... 11179-effective-period S0..1PeriodWhen data element is "valid"

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I1..1Resource data element
dae-1: Can have a maximum of one definitional binding or primary concept
inv-2: Must have either a code or an object-property mapping from the SDC value set
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... minLength S0..1integerAdditional Content defined by implementations
... maxLength S0..1integerAdditional Content defined by implementations
... regex S0..1stringAdditional Content defined by implementations
... entryFormat S0..1stringAdditional Content defined by implementations
... minValue S0..1date, dateTime, time, instant, decimal, integerAdditional Content defined by implementations
... maxValue S0..1date, dateTime, time, instant, decimal, integerAdditional Content defined by implementations
... maxDecimalPlaces S0..1integerAdditional Content defined by implementations
... 11179-effective-period S0..1PeriodAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriGlobally unique logical id for data element
... identifier S Σ1..1IdentifierLogical id to reference this data element
... version S Σ0..1stringLogical id for this version of the data element
... publisher S Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*Contact details of the publisher
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... name Σ0..1stringName of a individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... status M SΣ1..1codedraft | active | retired
Binding: ResourceDataElementStatus (required, not extensible)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... date S Σ0..1dateTimeDate for this version of the data element
... name S Σ1..1stringDescriptive label for this element definition
... category S Σ0..*CodeableConceptAssist with indexing and finding
... granularity S Σ1..1codecomparable | fully-specified | equivalent | convertable | scaleable | flexible
Binding: ComparableGranularity (required, not extensible)
... code S Σ0..1CodingA code that defines the data element in terms of SDC's data element concept value set.
... question S Σ0..1stringPrompt for element phrased as question
... label S Σ0..1stringName for element to display with or prompt for element
... definition S1..1stringDefinition/description as narrative text
... copyright 0..1stringUse and/or Publishing restrictions
... comments S0..1stringComments about the use of this element
... requirements S0..1stringWhy is this needed?
... synonym S0..*stringOther names
... type S1..1codeName of Data type
Binding: DataType (required, not extensible)
... example[x] 0..1*Example value: [as defined for type]
... maxLength S0..1integerLength for strings
... units[x] S0..1CodeableConcept, ValueSetUnits to use for measured value
Binding: Units (preferred, extensible)
... binding S I0..1ValueSet details if this is coded
dae-14: Example value sets are always extensible
dae-3: provide either a valueSet or a description (or both)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... isExtensible S I1..1booleanCan additional codes be used?
.... conformance S I0..1coderequired | preferred | example
Binding: BindingConformance (required, not extensible)
.... description I0..1stringHuman explanation of the value set
.... valueSet S I1..1ValueSetSource of value set
... mapping IMap element to another set of definitions
Slice: Unordered, Open, by uri
dae-26: Must have at a name or a uri (or both)
... mapping S I0..1A mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.
dae-26: Must have at a name or a uri (or both)
inv-1: Property extension can only be specified if ObjectClass extension is present
.... id 0..1idxml:id (or equivalent in JSON)
.... 11179-objectClass S1..1CodingAdditional Content defined by implementations
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... url 1..1uriidentifies the meaning of the extension
..... valueCoding S1..1CodingValue of extension
Binding: SDCObjectClass (required, extensible)
.... 11179-property S1..1CodingAdditional Content defined by implementations
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... url 1..1uriidentifies the meaning of the extension
..... valueCoding S1..1CodingValue of extension
Binding: SDCObjectClassProperty (required, extensible)
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... uri S I1..1uriIdentifies what this mapping refers to
Fixed Value: http://healthit.gov/sdc/objectclassproperty
.... definitional S0..1booleanTrue if mapping defines element
.... name S I0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
.... map S1..1stringThis 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]".

XML Template

JSON Template

todo

Differential View

This structure is derived from DataElement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I1..1inv-2: Must have either a code or an object-property mapping from the SDC value set
... telecom S0..*ContactPoint
... identifier S1..1Identifier
... version S0..1string
... publisher S0..1string
... status S1..1code
... date S0..1dateTime
... name S1..1string
... category S0..*CodeableConcept
... granularity S1..1codeBinding: ComparableGranularity (required, not extensible)
... code S I0..1CodingA code that defines the data element in terms of SDC's data element concept value set.
... question S0..1string
... label S0..1string
... definition S1..1string
... comments S0..1string
... requirements S0..1string
... synonym S0..*string
... type S1..1code
... example[x] 0..1*
... maxLength S0..1integer
... units[x] S0..1CodeableConcept, ValueSet
... binding S0..1
.... isExtensible S1..1boolean
.... conformance S0..1code
.... description 0..1string
.... valueSet S1..1ValueSet
... mapping Slice: Unordered, Open, by uri
... mapping S I0..1A mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.
inv-1: Property extension can only be specified if ObjectClass extension is present
.... uri S1..1uriFixed Value: http://healthit.gov/sdc/objectclassproperty
.... definitional S0..1boolean
.... name S0..1string
.... comments S0..1string
.... map S1..1stringThis 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]".
.... 11179-objectClass S I1..1CodingObject Class
..... valueCoding S1..1CodingBinding: SDCObjectClass (required, extensible)
.... 11179-property S I1..1CodingObject Class Property
..... valueCoding S1..1CodingBinding: SDCObjectClassProperty (required, extensible)
... minLength S0..1integerAt least this many characters
... maxLength S0..1integerNo more than this many characters
... regex S0..1stringRegular expression pattern
... entryFormat S0..1stringUser prompt for format
... minValue S0..1date, dateTime, time, instant, decimal, integerMust be >= this value
... maxValue S0..1date, dateTime, time, instant, decimal, integerMust be <= this value
... maxDecimalPlaces S0..1integerMaximum digits after decimal
... 11179-effective-period S0..1PeriodWhen data element is "valid"

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I1..1Resource data element
dae-1: Can have a maximum of one definitional binding or primary concept
inv-2: Must have either a code or an object-property mapping from the SDC value set
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... minLength S0..1integerAdditional Content defined by implementations
... maxLength S0..1integerAdditional Content defined by implementations
... regex S0..1stringAdditional Content defined by implementations
... entryFormat S0..1stringAdditional Content defined by implementations
... minValue S0..1date, dateTime, time, instant, decimal, integerAdditional Content defined by implementations
... maxValue S0..1date, dateTime, time, instant, decimal, integerAdditional Content defined by implementations
... maxDecimalPlaces S0..1integerAdditional Content defined by implementations
... 11179-effective-period S0..1PeriodAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriGlobally unique logical id for data element
... identifier S Σ1..1IdentifierLogical id to reference this data element
... version S Σ0..1stringLogical id for this version of the data element
... publisher S Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*Contact details of the publisher
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... name Σ0..1stringName of a individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... status M SΣ1..1codedraft | active | retired
Binding: ResourceDataElementStatus (required, not extensible)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... date S Σ0..1dateTimeDate for this version of the data element
... name S Σ1..1stringDescriptive label for this element definition
... category S Σ0..*CodeableConceptAssist with indexing and finding
... granularity S Σ1..1codecomparable | fully-specified | equivalent | convertable | scaleable | flexible
Binding: ComparableGranularity (required, not extensible)
... code S Σ0..1CodingA code that defines the data element in terms of SDC's data element concept value set.
... question S Σ0..1stringPrompt for element phrased as question
... label S Σ0..1stringName for element to display with or prompt for element
... definition S1..1stringDefinition/description as narrative text
... copyright 0..1stringUse and/or Publishing restrictions
... comments S0..1stringComments about the use of this element
... requirements S0..1stringWhy is this needed?
... synonym S0..*stringOther names
... type S1..1codeName of Data type
Binding: DataType (required, not extensible)
... example[x] 0..1*Example value: [as defined for type]
... maxLength S0..1integerLength for strings
... units[x] S0..1CodeableConcept, ValueSetUnits to use for measured value
Binding: Units (preferred, extensible)
... binding S I0..1ValueSet details if this is coded
dae-14: Example value sets are always extensible
dae-3: provide either a valueSet or a description (or both)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... isExtensible S I1..1booleanCan additional codes be used?
.... conformance S I0..1coderequired | preferred | example
Binding: BindingConformance (required, not extensible)
.... description I0..1stringHuman explanation of the value set
.... valueSet S I1..1ValueSetSource of value set
... mapping IMap element to another set of definitions
Slice: Unordered, Open, by uri
dae-26: Must have at a name or a uri (or both)
... mapping S I0..1A mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.
dae-26: Must have at a name or a uri (or both)
inv-1: Property extension can only be specified if ObjectClass extension is present
.... id 0..1idxml:id (or equivalent in JSON)
.... 11179-objectClass S1..1CodingAdditional Content defined by implementations
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... url 1..1uriidentifies the meaning of the extension
..... valueCoding S1..1CodingValue of extension
Binding: SDCObjectClass (required, extensible)
.... 11179-property S1..1CodingAdditional Content defined by implementations
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... url 1..1uriidentifies the meaning of the extension
..... valueCoding S1..1CodingValue of extension
Binding: SDCObjectClassProperty (required, extensible)
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... uri S I1..1uriIdentifies what this mapping refers to
Fixed Value: http://healthit.gov/sdc/objectclassproperty
.... definitional S0..1booleanTrue if mapping defines element
.... name S I0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
.... map S1..1stringThis 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]".

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
DataElement.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
DataElement.statusResourceDataElementStatusrequiredResourceDataElementStatus
DataElement.granularityComparableGranularityrequiredDataElement SDC Concept
DataElement.typeDataTyperequiredDataType
DataElement.units[x]Unitspreferred (extensible)UCUM Codes
DataElement.binding.conformanceBindingConformancerequiredBindingConformance
DataElement.mapping.extension.valueCodingSDCObjectClassPropertyrequired (extensible)DataElement SDC Object Class
DataElement.mapping.extension.valueCodingSDCObjectClassPropertyrequired (extensible)DataElement SDC Object Class

Constraints

IdPathNameDetails
dae-1DataElementOnly one definitionalCan have a maximum of one definitional binding or primary concept
XPath: count(f:concept[f:primary[@value='true']|f:mapping/f:definitional[@value='true']])<=1
inv-2DataElementMust have either a code or an object-property mapping from the SDC value set
XPath: exists(f:code) or exists(f:mapping[f:uri/@value='http://healthit.gov/sdc/objectclassproperty'])
dae-14DataElement.bindingExamples extensibleExample value sets are always extensible
XPath: not(f:conformance/@value='example' and f:isExtensible/@value='false')
dae-3DataElement.bindingValueset or descriptionprovide either a valueSet or a description (or both)
XPath: (exists(f:valueSet)) or exists(f:description)
dae-26DataElement.mappingName or URIMust have at a name or a uri (or both)
XPath: exists(f:uri) or exists(f:name)
inv-1DataElement.mappingProperty extension can only be specified if ObjectClass extension is present
XPath: exists(f:extension[@url='http://hl7.org/fhir/ExtensionDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/ExtensionDefinition/11179-property']))
dae-26DataElement.mappingName or URIMust have at a name or a uri (or both)
XPath: exists(f:uri) or exists(f:name)
inv-1DataElement.mappingProperty extension can only be specified if ObjectClass extension is present
XPath: exists(f:extension[@url='http://hl7.org/fhir/ExtensionDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/ExtensionDefinition/11179-property']))
.