DSTU2 QA Preview

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

B.3.1 StructureDefinition: SDC-Element

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/sdc-element

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 Health Level Seven International (Orders and Observations - Structured Data Capture).

B.3.1.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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement 0..*DataElement
... url S1..1uri
... identifier S1..*Identifier
... version S0..1string
... name S1..1string
... status S1..1code
... experimental S0..1boolean
... publisher S0..1string
... contact S0..*BackboneElement
.... telecom S0..*ContactPoint
... date S0..1dateTime
... useContext S0..*CodeableConcept
... copyright S0..1string
... stringency S1..1code
... mapping S0..*BackboneElement
.... identity S1..1id
.... uri S0..1uri
.... name S0..1string
.... comments S0..1string
... element S1..*ElementDefinition
.... path S1..1
.... representation
.... name S
.... label S
.... code S
.... slicing
.... short string
.... definition S1..1
.... comments S
.... requirements S
.... alias S
.... min S0..0
.... max S0..0
.... base 0..0
.... type S0..1
..... code S
..... profile
..... aggregation
.... nameReference
.... defaultValue[x] 0..0
.... meaningWhenMissing 0..0
.... fixed[x]
.... pattern[x]
.... example[x] S0..1
.... minValue[x] S0..1integer, decimal, instant, date, time, dateTime, Quantity
.... maxValue[x] S0..1integer, decimal, instant, date, time, dateTime, Quantity
.... maxLength S0..1
.... condition S0..0
.... constraint S0..0
.... mustSupport 0..0
.... isModifier
.... isSummary
.... binding S
..... strength S
..... description S
..... valueSetReference S1..1Reference(ValueSet)
.... mapping S0..*
..... elementdefinition-equivalence S1..1codeequivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence
Slice: Unordered, Open, by url
...... valueCode S1..1codeFixed Value: equivalent
..... identity S
..... language SBinding: DEX mapping language mime types (extensible)
..... map S
..... elementdefinition-equivalence S1..1codeequivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence
Slice: Unordered, Open, by url
...... valueCode S1..1codeFixed Value: equivalent
.... elementdefinition-question S0..*stringPrompt for element phrased as question
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-question
Slice: Unordered, Open, by url
.... elementdefinition-allowedUnits S0..1CodeableConcept, Reference(ValueSet)Units to use for measured value
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits
.... minLength S0..1integerAt least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
.... regex S0..1stringRegular expression pattern
URL: http://hl7.org/fhir/StructureDefinition/regex
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... maxDecimalPlaces S0..1integerMaximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement 0..*DataElementResource data element
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S ∑1..1uriGlobally unique logical id for data element
... identifier S ∑1..*IdentifierLogical id to reference this data element
... version S ∑0..1stringLogical id for this version of the data element
... name S ∑1..1stringDescriptive label for this element definition
... status ?! S∑1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... experimental S ∑0..1booleanIf for testing purposes, not real usage
... publisher S ∑0..1stringName of the publisher (Organization or individual)
... contact S ∑0..*BackboneElementContact details of the publisher
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name ∑0..1stringName of a individual to contact
.... telecom S ∑0..*ContactPointContact details for individual or publisher
... date S ∑0..1dateTimeDate for this version of the data element
... useContext S ∑0..*CodeableConceptContent intends to support these contexts
Binding: Context of Use ValueSet (extensible)
... copyright S0..1stringUse and/or Publishing restrictions
... stringency S ∑1..1codecomparable | fully-specified | equivalent | convertable | scaleable | flexible
Binding: DataElementStringency (required)
... mapping S0..*BackboneElementExternal 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
.... uri S0..1uriIdentifies what this mapping refers to
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... element S ∑I1..*ElementDefinitionDefinition of element
dae-1: No base allowed
dae-2: No slicing allowed

doco Documentation for this format

todo

Differential View

This structure is derived from DataElement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement 0..*DataElement
... url S1..1uri
... identifier S1..*Identifier
... version S0..1string
... name S1..1string
... status S1..1code
... experimental S0..1boolean
... publisher S0..1string
... contact S0..*BackboneElement
.... telecom S0..*ContactPoint
... date S0..1dateTime
... useContext S0..*CodeableConcept
... copyright S0..1string
... stringency S1..1code
... mapping S0..*BackboneElement
.... identity S1..1id
.... uri S0..1uri
.... name S0..1string
.... comments S0..1string
... element S1..*ElementDefinition
.... path S1..1
.... representation
.... name S
.... label S
.... code S
.... slicing
.... short string
.... definition S1..1
.... comments S
.... requirements S
.... alias S
.... min S0..0
.... max S0..0
.... base 0..0
.... type S0..1
..... code S
..... profile
..... aggregation
.... nameReference
.... defaultValue[x] 0..0
.... meaningWhenMissing 0..0
.... fixed[x]
.... pattern[x]
.... example[x] S0..1
.... minValue[x] S0..1integer, decimal, instant, date, time, dateTime, Quantity
.... maxValue[x] S0..1integer, decimal, instant, date, time, dateTime, Quantity
.... maxLength S0..1
.... condition S0..0
.... constraint S0..0
.... mustSupport 0..0
.... isModifier
.... isSummary
.... binding S
..... strength S
..... description S
..... valueSetReference S1..1Reference(ValueSet)
.... mapping S0..*
..... elementdefinition-equivalence S1..1codeequivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence
Slice: Unordered, Open, by url
...... valueCode S1..1codeFixed Value: equivalent
..... identity S
..... language SBinding: DEX mapping language mime types (extensible)
..... map S
..... elementdefinition-equivalence S1..1codeequivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence
Slice: Unordered, Open, by url
...... valueCode S1..1codeFixed Value: equivalent
.... elementdefinition-question S0..*stringPrompt for element phrased as question
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-question
Slice: Unordered, Open, by url
.... elementdefinition-allowedUnits S0..1CodeableConcept, Reference(ValueSet)Units to use for measured value
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits
.... minLength S0..1integerAt least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
.... regex S0..1stringRegular expression pattern
URL: http://hl7.org/fhir/StructureDefinition/regex
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... maxDecimalPlaces S0..1integerMaximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement 0..*DataElementResource data element
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S ∑1..1uriGlobally unique logical id for data element
... identifier S ∑1..*IdentifierLogical id to reference this data element
... version S ∑0..1stringLogical id for this version of the data element
... name S ∑1..1stringDescriptive label for this element definition
... status ?! S∑1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... experimental S ∑0..1booleanIf for testing purposes, not real usage
... publisher S ∑0..1stringName of the publisher (Organization or individual)
... contact S ∑0..*BackboneElementContact details of the publisher
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name ∑0..1stringName of a individual to contact
.... telecom S ∑0..*ContactPointContact details for individual or publisher
... date S ∑0..1dateTimeDate for this version of the data element
... useContext S ∑0..*CodeableConceptContent intends to support these contexts
Binding: Context of Use ValueSet (extensible)
... copyright S0..1stringUse and/or Publishing restrictions
... stringency S ∑1..1codecomparable | fully-specified | equivalent | convertable | scaleable | flexible
Binding: DataElementStringency (required)
... mapping S0..*BackboneElementExternal 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
.... uri S0..1uriIdentifies what this mapping refers to
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... element S ∑I1..*ElementDefinitionDefinition of element
dae-1: No base allowed
dae-2: No slicing allowed

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

B.3.1.2 Terminology Bindings

PathNameConformanceValueSet
DataElement.language?extrequiredhttp://tools.ietf.org/html/bcp47
DataElement.statusConformanceResourceStatusrequiredConformanceResourceStatus
DataElement.useContextContext of Use ValueSetextensibleContext of Use ValueSet
DataElement.stringencyDataElementStringencyrequiredDataElementStringency

B.3.1.3 Constraints

IdPathDetailsRequirements
dae-1DataElement.elementNo base allowed
XPath: not(exists(f:base))
dae-2DataElement.elementNo slicing allowed
XPath: not(exists(f:slicing))
.