DSTU2 Ballot Source

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

6.20.13.4 StructureDefinition: SDCElement

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/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

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.

6.20.13.4.1 Formal Views of Profile Content

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

This structure is derived from DataElement.

Summary

Mandatory: 21 elements, Must-Support: 79 elements, Fixed Value: 3 elements, Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element DataElement.mapping is sliced based on the value of uri
  • The element DataElement.element.mapping is sliced based on the value of identity

This structure is derived from DataElement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I1..1DataElementinv-2: One and only one DataElement.code must have is-data-element-concept set to "true"
... url S
... identifier S1..1
... version S1..1
... name S1..1
... useContext S
.... 11179-de-classification-or-context S1..1codecontext | classification
... experimental S
... status S
... date S
... copyright S
... publisher S1..1string
... contact S1..*
.... name S1..1
.... telecom S1..1
.... 11179-de-contact-address S0..1AddressHow to mail contact
... specificity S1..1
... mapping Slice: Unordered, Open, by uri
... mapping S1..1
.... identity SidFixed Value: objclass-prop
.... uri S1..1uriFixed Value: http://healthit.gov/sdc/objectclassproperty
.... name S
.... comments S
... mapping S Iinv-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
..... 11179-de-is-data-element-concept I0..1booleanIs code the DEC for the data element?
.... definition S1..1
.... comments S
.... requirements S
.... alias S0..*
.... min S
.... max S
.... type S0..1
..... code S
.... defaultValue[x]
.... meaningWhenMissing
.... example[x] S
.... maxLength S
.... condition S
.... constraint S
..... key S
..... name S
..... severity S
..... human S
..... xpath S
.... mustSupport 0..0
.... binding S
..... name S
..... strength S
..... description S
..... valueSetReference S I1..1ValueSetinv-3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present
...... 11179-permitted-value-valueset S I0..1ValueSetPermitted values
...... 11179-permitted-value-conceptmap S I0..1ConceptMapMapping from permitted to transmitted
.... mapping Slice: Unordered, Open, by identity
.... mapping S IA mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.
..... identity idFixed Value: objclass-prop
..... map S1..1This 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..1Coding
..... 11179-objectClassProperty S I1..1CodingObject Class Property
...... valueCoding S1..1Coding
.... mapping S I0..*
..... language SBinding: DEXMappingLanguage (extensible)
..... map S
..... elementdefinition-equivalence S0..1codeequivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint
.... minLength S0..1integerAt least 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
.... elementdefinition-question S2..*stringPrompt for element phrased as question
.... elementdefinition-allowedUnits S0..1CodeableConcept, ValueSetUnits to use for measured value
... 11179-de-effective-period S0..1PeriodWhen data element is "valid"
... 11179-de-document-reference S0..*DocumentReferencePointer to document related to data element
... 11179-de-administrative-status S1..1CodeableConceptStatus of internal processing
... 11179-de-change-description S0..1stringWhat's changed since the last "business" version?
... 11179-de-submitter-org S1..1OrganizationWho submitted data element to registry
... 11179-de-registry-org S1..1OrganizationOrganization responsible for registry
NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I1..1DataElementResource data element
inv-2: One and only one DataElement.code must have is-data-element-concept set to "true"
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... 11179-de-effective-period S0..1PeriodExtension
... 11179-de-document-reference S0..*DocumentReferenceExtension
... 11179-de-administrative-status S1..1CodeableConceptExtension
... 11179-de-change-description S0..1stringExtension
... 11179-de-submitter-org S1..1OrganizationExtension
... 11179-de-registry-org S1..1OrganizationExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S Σ0..1uriGlobally unique logical id for data element
... identifier S Σ1..1IdentifierLogical id to reference this data element
... version S Σ1..1stringLogical id for this version of the data element
... name S Σ1..1stringDescriptive label for this element definition
... useContext S Σ0..*CodeableConceptContent intends to support these contexts
Binding: ConformanceUseContext (extensible)
.... 11179-de-classification-or-context S1..1codeExtension
.... coding 0..*CodingCode defined by a terminology system
.... text 0..1stringPlain text representation of the concept
... experimental S Σ0..1booleanIf for testing purposes, not real usage
... status ?! SΣ1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... date S Σ0..1dateTimeDate for this version of the data element
... copyright S0..1stringUse and/or Publishing restrictions
... publisher S Σ1..1stringName of the publisher (Organization or individual)
... contact S Σ1..*Contact details of the publisher
.... 11179-de-contact-address S0..1AddressExtension
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name S Σ1..1stringName of a individual to contact
.... telecom S Σ1..1ContactPointContact details for individual or publisher
... specificity S Σ1..1codecomparable | fully-specified | equivalent | convertable | scaleable | flexible
Binding: DataElementSpecificity (required)
... mapping External specification mapped to
Slice: Unordered, Open, by uri
... mapping S1..1External specification mapped to
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identity S1..1idInternal id when this mapping is used
Fixed Value: objclass-prop
.... uri S1..1uriIdentifies what this mapping refers to
Fixed Value: http://healthit.gov/sdc/objectclassproperty
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... mapping S I0..*External specification mapped to
inv-1: Property extension can only be specified if ObjectClass extension is present
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identity S1..1idInternal id when this mapping is used
.... uri S0..1uriIdentifies what this mapping refers to
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... element S1..*ElementDefinitionDefinition of element

todo

This structure is derived from DataElement.

Summary

Mandatory: 21 elements, Must-Support: 79 elements, Fixed Value: 3 elements, Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element DataElement.mapping is sliced based on the value of uri
  • The element DataElement.element.mapping is sliced based on the value of identity

Differential View

This structure is derived from DataElement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I1..1DataElementinv-2: One and only one DataElement.code must have is-data-element-concept set to "true"
... url S
... identifier S1..1
... version S1..1
... name S1..1
... useContext S
.... 11179-de-classification-or-context S1..1codecontext | classification
... experimental S
... status S
... date S
... copyright S
... publisher S1..1string
... contact S1..*
.... name S1..1
.... telecom S1..1
.... 11179-de-contact-address S0..1AddressHow to mail contact
... specificity S1..1
... mapping Slice: Unordered, Open, by uri
... mapping S1..1
.... identity SidFixed Value: objclass-prop
.... uri S1..1uriFixed Value: http://healthit.gov/sdc/objectclassproperty
.... name S
.... comments S
... mapping S Iinv-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
..... 11179-de-is-data-element-concept I0..1booleanIs code the DEC for the data element?
.... definition S1..1
.... comments S
.... requirements S
.... alias S0..*
.... min S
.... max S
.... type S0..1
..... code S
.... defaultValue[x]
.... meaningWhenMissing
.... example[x] S
.... maxLength S
.... condition S
.... constraint S
..... key S
..... name S
..... severity S
..... human S
..... xpath S
.... mustSupport 0..0
.... binding S
..... name S
..... strength S
..... description S
..... valueSetReference S I1..1ValueSetinv-3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present
...... 11179-permitted-value-valueset S I0..1ValueSetPermitted values
...... 11179-permitted-value-conceptmap S I0..1ConceptMapMapping from permitted to transmitted
.... mapping Slice: Unordered, Open, by identity
.... mapping S IA mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.
..... identity idFixed Value: objclass-prop
..... map S1..1This 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..1Coding
..... 11179-objectClassProperty S I1..1CodingObject Class Property
...... valueCoding S1..1Coding
.... mapping S I0..*
..... language SBinding: DEXMappingLanguage (extensible)
..... map S
..... elementdefinition-equivalence S0..1codeequivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint
.... minLength S0..1integerAt least 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
.... elementdefinition-question S2..*stringPrompt for element phrased as question
.... elementdefinition-allowedUnits S0..1CodeableConcept, ValueSetUnits to use for measured value
... 11179-de-effective-period S0..1PeriodWhen data element is "valid"
... 11179-de-document-reference S0..*DocumentReferencePointer to document related to data element
... 11179-de-administrative-status S1..1CodeableConceptStatus of internal processing
... 11179-de-change-description S0..1stringWhat's changed since the last "business" version?
... 11179-de-submitter-org S1..1OrganizationWho submitted data element to registry
... 11179-de-registry-org S1..1OrganizationOrganization responsible for registry

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I1..1DataElementResource data element
inv-2: One and only one DataElement.code must have is-data-element-concept set to "true"
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... 11179-de-effective-period S0..1PeriodExtension
... 11179-de-document-reference S0..*DocumentReferenceExtension
... 11179-de-administrative-status S1..1CodeableConceptExtension
... 11179-de-change-description S0..1stringExtension
... 11179-de-submitter-org S1..1OrganizationExtension
... 11179-de-registry-org S1..1OrganizationExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S Σ0..1uriGlobally unique logical id for data element
... identifier S Σ1..1IdentifierLogical id to reference this data element
... version S Σ1..1stringLogical id for this version of the data element
... name S Σ1..1stringDescriptive label for this element definition
... useContext S Σ0..*CodeableConceptContent intends to support these contexts
Binding: ConformanceUseContext (extensible)
.... 11179-de-classification-or-context S1..1codeExtension
.... coding 0..*CodingCode defined by a terminology system
.... text 0..1stringPlain text representation of the concept
... experimental S Σ0..1booleanIf for testing purposes, not real usage
... status ?! SΣ1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... date S Σ0..1dateTimeDate for this version of the data element
... copyright S0..1stringUse and/or Publishing restrictions
... publisher S Σ1..1stringName of the publisher (Organization or individual)
... contact S Σ1..*Contact details of the publisher
.... 11179-de-contact-address S0..1AddressExtension
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name S Σ1..1stringName of a individual to contact
.... telecom S Σ1..1ContactPointContact details for individual or publisher
... specificity S Σ1..1codecomparable | fully-specified | equivalent | convertable | scaleable | flexible
Binding: DataElementSpecificity (required)
... mapping External specification mapped to
Slice: Unordered, Open, by uri
... mapping S1..1External specification mapped to
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identity S1..1idInternal id when this mapping is used
Fixed Value: objclass-prop
.... uri S1..1uriIdentifies what this mapping refers to
Fixed Value: http://healthit.gov/sdc/objectclassproperty
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... mapping S I0..*External specification mapped to
inv-1: Property extension can only be specified if ObjectClass extension is present
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identity S1..1idInternal id when this mapping is used
.... uri S0..1uriIdentifies what this mapping refers to
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... element S1..*ElementDefinitionDefinition of element

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

6.20.13.4.2 Terminology Bindings

PathNameConformanceValueSet
DataElement.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
DataElement.useContextConformanceUseContextextensibleContext of Use ValueSet
DataElement.statusConformanceResourceStatusrequiredConformanceResourceStatus
DataElement.specificityDataElementSpecificityrequiredDataElementSpecificity

6.20.13.4.3 Constraints

IdPathNameDetails
inv-2DataElementOne and only one DataElement.code must have is-data-element-concept set to "true"
XPath: count(f:code/f:extension[@uri='http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept'])=1
inv-1DataElement.mappingProperty 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']))
inv-1DataElement.mappingProperty 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']))
inv-1DataElement.mappingProperty 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']))
.