Structured Data Capture - Data Element Exchange 2.0 (STU2)
This page is part of the Structured Data Capture - Data Element Exchange Specification (v2.0: STU 2) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/sdcde/StructureDefinition/sdcde-dataelement
This profile is a placeholder and is not complete. It will eventually set expectations for the capability of data element registry systems as well as systems that create and curate data elements. It expands on the expectations of the base SDC DataElement profile by adding DataElement properties relevant for maintenance of data elements, rather than merely what is sufficient to allow a data element to be referenced within a form. Guidance found within that profile also applies to this one.
For the purposes of this profile, Supported means that clients SHALL be capable of processing the element/extension and use the information to control the display and information capture associated with the DataElement. It means that servers SHALL be capable of persisting those elements and returning them in response to requests.
This profile relies on the use of a number of other profiles, some required, others available for use "when necessary":
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DataElement
Summary
Mandatory: 15 elements (7 nested mandatory elements)
Must-Support: 83 elements
Fixed Value: 4 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from DataElement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DataElement | I | 0..* | Resource data element | |
  id | Σ | 0..1 | id | Logical id of this artifact |
 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 11179-de-effective-period | SI | 0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period |
| 11179-de-document-reference | SI | 0..1 | Reference(DocumentReference) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-document-reference |
| 11179-de-administrative-status | SI | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status Binding: (unbound) (example) |
| 11179-de-change-description | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-change-description |
| 11179-de-submitter-org | SI | 1..1 | Reference(Organization) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org |
| 11179-de-registry-org | SI | 1..1 | Reference(Organization) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-registry-org |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Logical URI to reference this data element (globally unique) |
| identifier | SΣ | 1..1 | Identifier | Additional identifier for the data element |
| version | SΣ | 1..1 | string | Business version of the data element |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ?!SΣ | 0..1 | boolean | For testing purposes, not real usage |
| date | SΣ | 0..1 | dateTime | Date this was last changed |
| publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
| name | SΣ | 1..1 | string | Name for this data element (computer friendly) |
| title | Σ | 0..1 | string | Name for this data element (human friendly) |
| contact | SΣ | 1..* | ContactDetail | Contact details for the publisher |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-de-contact-address | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-contact-address |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-de-contact-address" | |
 valueAddress | 0..1 | Address | Value of extension | |
| name | SΣ | 1..1 | string | Name of an individual to contact |
| telecom | SΣ | 1..1 | ContactPoint | Contact details for individual or organization |
| useContext | SΣ | 0..* | UsageContext | Context the content is intended to support |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-de-classification-or-context | S | 1..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context Binding: ClassificationOrContext (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context" | |
| valueCode | 0..1 | code | Value of extension Binding: ClassificationOrContext (required) | |
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) |
 value[x] | Σ | 1..1 | CodeableConcept, Quantity, Range | Value that defines the context Binding: Context of Use ValueSet (example) |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for data element (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| stringency | SΣ | 1..1 | code | comparable | fully-specified | equivalent | convertable | scaleable | flexible Binding: DataElementStringency (required) Fixed Value: comparable |
| mapping | SI | 1..1 | BackboneElement | External specification mapped to 1: Property extension can only be specified if ObjectClass extension is present |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 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 Fixed Value: objclass-prop |
| uri | S | 1..1 | uri | Identifies what this mapping refers to Fixed Value: http://healthit.gov/sdc/objectclassproperty |
| name | S | 0..1 | string | Names what this mapping refers to |
 comment | S | string | Versions, issues, scope limitations, etc. Slice: Unordered, Open by value:uri | |
| mapping | SI | 0..* | BackboneElement | External specification mapped to |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 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 |
| comment | S | 0..1 | string | Versions, issues, scope limitations, etc. |
| element | SΣI | 1..* | ElementDefinition | Definition of element 2: One and only one DataElement.code must have is-data-element-concept set to "true" |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| elementdefinition-question | S | 2..* | string | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-question |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/elementdefinition-question" | |
| valueString | 0..1 | string | Value of extension | |
| elementdefinition-allowedUnits | S | 0..* | CodeableConcept, Reference(ValueSet) | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits Binding: UCUM Codes (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" | |
| value[x] | 1..1 | CodeableConcept, Reference(ValueSet) | Value of extension Binding: UCUM Codes (required) | |
| minLength | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minLength |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minLength" | |
| valueInteger | 0..1 | integer | Value of extension | |
| regex | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/regex |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/regex" | |
| valueString | 0..1 | string | Value of extension | |
| entryFormat | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/entryFormat |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/entryFormat" | |
| valueString | 0..1 | string | Value of extension | |
| maxDecimalPlaces | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces" | |
| valueInteger | 0..1 | integer | Value of extension | |
| path | SΣ | 1..1 | string | Path of the element in the hierarchy of elements |
| representation | Σ | 0..* | code | xmlAttr | xmlText | typeAttr | cdaText | xhtml Binding: PropertyRepresentation (required) |
| label | SΣ | 0..1 | string | Name for element to display with or prompt for element |
| code | SΣ | 0..* | Coding | Corresponding codes in terminologies Binding: DataElement SDC Concept (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-de-is-data-element-concept | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept" | |
| valueBoolean | 0..1 | boolean | Value of extension | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| short | Σ | 0..1 | string | Concise definition for space-constrained presentation |
| definition | SΣ | 1..1 | markdown | Full formal definition as narrative text |
| comment | SΣ | 0..1 | markdown | Comments about the use of this element |
| requirements | SΣ | 0..1 | markdown | Why this resource has been created |
| alias | SΣ | 0..* | string | Other names |
| min | SΣI | 0..1 | unsignedInt | Minimum Cardinality |
| max | SΣI | 0..1 | string | Maximum Cardinality (a number or *) |
| type | SΣI | 0..1 | Element | Data type and Profile for this element |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| code | SΣ | 1..1 | uri | Data type or Resource (reference to definition) |
| profile | Σ | 0..1 | uri | Profile (StructureDefinition) to apply (or IG) |
| targetProfile | Σ | 0..1 | uri | Profile (StructureDefinition) to apply to reference target (or IG) |
| aggregation | ΣI | 0..* | code | contained | referenced | bundled - how aggregated Binding: AggregationMode (required) |
| versioning | Σ | 0..1 | code | either | independent | specific Binding: ReferenceVersionRules (required) |
| defaultValue[x] | ΣI | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Specified value if missing from instance |
| meaningWhenMissing | ΣI | 0..1 | markdown | Implicit meaning when this element is missing |
| orderMeaning | Σ | 0..1 | string | What the order of the elements means |
| example | SΣI | 0..* | Element | Example value (as defined for type) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| label | SΣ | 1..1 | string | Describes the purpose of this example |
| value[x] | SΣ | 1..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of Example (one of allowed types) |
| minValue[x] | SΣ | 0..1 | date, dateTime, instant, time, decimal, integer, positiveInt, unsignedInt, Quantity | Minimum Allowed Value (for some types) |
| maxValue[x] | SΣ | 0..1 | date, dateTime, instant, time, decimal, integer, positiveInt, unsignedInt, Quantity | Maximum Allowed Value (for some types) |
| maxLength | SΣ | 0..1 | integer | Max length for strings |
| condition | SΣ | 0..* | id | Reference to invariant about presence |
| constraint | SΣI | 0..* | Element | Condition that must evaluate to true |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| key | SΣI | 1..1 | id | Target of 'condition' reference above |
| requirements | SΣ | 0..1 | string | Why this constraint is necessary or appropriate |
| severity | SΣ | 1..1 | code | error | warning Binding: ConstraintSeverity (required) |
| human | SΣ | 1..1 | string | Human description of constraint |
| expression | SΣ | 1..1 | string | FHIRPath expression of constraint |
| xpath | SΣ | 0..1 | string | XPath expression of constraint |
| source | Σ | 0..1 | uri | Reference to original source of constraint |
| isModifier | Σ | 0..1 | boolean | If this modifies the meaning of other elements |
| isSummary | Σ | 0..1 | boolean | Include when _summary = true? |
| binding | SΣI | 0..1 | Element | ValueSet details if this is coded |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| strength | SΣ | 1..1 | code | required | extensible | preferred | example Binding: BindingStrength (required) |
| description | SΣI | 0..1 | string | Human explanation of the value set |
 valueSetReference | SΣI | 1..1 | Reference(Structured Data Capture Data Element Exchange Value Set) | Source of value set 3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-permitted-value-valueset | S | 0..1 | Reference(ValueSet) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset" | |
| valueReference | 0..1 | Reference(ValueSet) | Value of extension | |
| 11179-permitted-value-conceptmap | S | 0..1 | Reference(ConceptMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap" | |
| valueReference | 0..1 | Reference(ConceptMap) | Value of extension | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| mapping | SΣI | 0..1 | Element | Map element to another set of definitions |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-objectClass | S | 1..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-objectClass Binding: DataElement SDC Object Class (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-objectClass" | |
| valueCoding | S | 1..1 | Coding | Value of extension Binding: DataElement SDC Concept (extensible) |
| 11179-objectClassProperty | S | 1..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty Binding: DataElement SDC Object Class (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty" | |
| valueCoding | S | 1..1 | Coding | Value of extension Binding: DataElement SDC Concept (extensible) |
| identity | SΣ | 1..1 | id | Reference to mapping declaration Fixed Value: objclass-prop |
| language | Σ | 0..1 | code | Computable language of mapping Binding: IETF BCP-13 (required) |
| map | SΣ | string | Details of the mapping Slice: Unordered, Open by value:identity | |
| comment | Σ | 0..1 | string | Comments about the mapping or its use |
| mapping | SΣI | 0..* | Element | Map element to another set of definitions |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| elementdefinition-equivalence | S | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence Binding: ConceptMapEquivalence (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence" | |
| valueCode | 0..1 | code | Value of extension Binding: ConceptMapEquivalence (required) | |
| identity | SΣ | 1..1 | id | Reference to mapping declaration |
| language | SΣ | 0..1 | code | Computable language of mapping Binding: IETF BCP-13 (required) |
| map | SΣ | 1..1 | string | Details of the mapping |
| comment | Σ | 0..1 | string | Comments about the mapping or its use |
| Documentation for this format | ||||
This structure is derived from DataElement
Summary
Mandatory: 15 elements (7 nested mandatory elements)
Must-Support: 83 elements
Fixed Value: 4 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from DataElement
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DataElement | I | 0..* | Resource data element | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| 11179-de-effective-period | SI | 0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period |
| 11179-de-document-reference | SI | 0..1 | Reference(DocumentReference) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-document-reference |
| 11179-de-administrative-status | SI | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status Binding: (unbound) (example) |
| 11179-de-change-description | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-change-description |
| 11179-de-submitter-org | SI | 1..1 | Reference(Organization) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org |
| 11179-de-registry-org | SI | 1..1 | Reference(Organization) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-registry-org |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Logical URI to reference this data element (globally unique) |
| identifier | SΣ | 1..1 | Identifier | Additional identifier for the data element |
| version | SΣ | 1..1 | string | Business version of the data element |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ?!SΣ | 0..1 | boolean | For testing purposes, not real usage |
| date | SΣ | 0..1 | dateTime | Date this was last changed |
| publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
| name | SΣ | 1..1 | string | Name for this data element (computer friendly) |
| title | Σ | 0..1 | string | Name for this data element (human friendly) |
| contact | SΣ | 1..* | ContactDetail | Contact details for the publisher |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-de-contact-address | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-contact-address |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-de-contact-address" | |
| valueAddress | 0..1 | Address | Value of extension | |
| name | SΣ | 1..1 | string | Name of an individual to contact |
| telecom | SΣ | 1..1 | ContactPoint | Contact details for individual or organization |
| useContext | SΣ | 0..* | UsageContext | Context the content is intended to support |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-de-classification-or-context | S | 1..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context Binding: ClassificationOrContext (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context" | |
| valueCode | 0..1 | code | Value of extension Binding: ClassificationOrContext (required) | |
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) |
| value[x] | Σ | 1..1 | CodeableConcept, Quantity, Range | Value that defines the context Binding: Context of Use ValueSet (example) |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for data element (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| stringency | SΣ | 1..1 | code | comparable | fully-specified | equivalent | convertable | scaleable | flexible Binding: DataElementStringency (required) Fixed Value: comparable |
| mapping | SI | 1..1 | BackboneElement | External specification mapped to 1: Property extension can only be specified if ObjectClass extension is present |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 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 Fixed Value: objclass-prop |
| uri | S | 1..1 | uri | Identifies what this mapping refers to Fixed Value: http://healthit.gov/sdc/objectclassproperty |
| name | S | 0..1 | string | Names what this mapping refers to |
| comment | S | string | Versions, issues, scope limitations, etc. Slice: Unordered, Open by value:uri | |
| mapping | SI | 0..* | BackboneElement | External specification mapped to |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 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 |
| comment | S | 0..1 | string | Versions, issues, scope limitations, etc. |
| element | SΣI | 1..* | ElementDefinition | Definition of element 2: One and only one DataElement.code must have is-data-element-concept set to "true" |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| elementdefinition-question | S | 2..* | string | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-question |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/elementdefinition-question" | |
| valueString | 0..1 | string | Value of extension | |
| elementdefinition-allowedUnits | S | 0..* | CodeableConcept, Reference(ValueSet) | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits Binding: UCUM Codes (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits" | |
| value[x] | 1..1 | CodeableConcept, Reference(ValueSet) | Value of extension Binding: UCUM Codes (required) | |
| minLength | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minLength |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minLength" | |
| valueInteger | 0..1 | integer | Value of extension | |
| regex | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/regex |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/regex" | |
| valueString | 0..1 | string | Value of extension | |
| entryFormat | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/entryFormat |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/entryFormat" | |
| valueString | 0..1 | string | Value of extension | |
| maxDecimalPlaces | S | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces" | |
| valueInteger | 0..1 | integer | Value of extension | |
| path | SΣ | 1..1 | string | Path of the element in the hierarchy of elements |
| representation | Σ | 0..* | code | xmlAttr | xmlText | typeAttr | cdaText | xhtml Binding: PropertyRepresentation (required) |
| label | SΣ | 0..1 | string | Name for element to display with or prompt for element |
| code | SΣ | 0..* | Coding | Corresponding codes in terminologies Binding: DataElement SDC Concept (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-de-is-data-element-concept | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept" | |
| valueBoolean | 0..1 | boolean | Value of extension | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| short | Σ | 0..1 | string | Concise definition for space-constrained presentation |
| definition | SΣ | 1..1 | markdown | Full formal definition as narrative text |
| comment | SΣ | 0..1 | markdown | Comments about the use of this element |
| requirements | SΣ | 0..1 | markdown | Why this resource has been created |
| alias | SΣ | 0..* | string | Other names |
| min | SΣI | 0..1 | unsignedInt | Minimum Cardinality |
| max | SΣI | 0..1 | string | Maximum Cardinality (a number or *) |
| type | SΣI | 0..1 | Element | Data type and Profile for this element |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| code | SΣ | 1..1 | uri | Data type or Resource (reference to definition) |
| profile | Σ | 0..1 | uri | Profile (StructureDefinition) to apply (or IG) |
| targetProfile | Σ | 0..1 | uri | Profile (StructureDefinition) to apply to reference target (or IG) |
| aggregation | ΣI | 0..* | code | contained | referenced | bundled - how aggregated Binding: AggregationMode (required) |
| versioning | Σ | 0..1 | code | either | independent | specific Binding: ReferenceVersionRules (required) |
| defaultValue[x] | ΣI | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Specified value if missing from instance |
| meaningWhenMissing | ΣI | 0..1 | markdown | Implicit meaning when this element is missing |
| orderMeaning | Σ | 0..1 | string | What the order of the elements means |
| example | SΣI | 0..* | Element | Example value (as defined for type) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| label | SΣ | 1..1 | string | Describes the purpose of this example |
| value[x] | SΣ | 1..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of Example (one of allowed types) |
| minValue[x] | SΣ | 0..1 | date, dateTime, instant, time, decimal, integer, positiveInt, unsignedInt, Quantity | Minimum Allowed Value (for some types) |
| maxValue[x] | SΣ | 0..1 | date, dateTime, instant, time, decimal, integer, positiveInt, unsignedInt, Quantity | Maximum Allowed Value (for some types) |
| maxLength | SΣ | 0..1 | integer | Max length for strings |
| condition | SΣ | 0..* | id | Reference to invariant about presence |
| constraint | SΣI | 0..* | Element | Condition that must evaluate to true |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| key | SΣI | 1..1 | id | Target of 'condition' reference above |
| requirements | SΣ | 0..1 | string | Why this constraint is necessary or appropriate |
| severity | SΣ | 1..1 | code | error | warning Binding: ConstraintSeverity (required) |
| human | SΣ | 1..1 | string | Human description of constraint |
| expression | SΣ | 1..1 | string | FHIRPath expression of constraint |
| xpath | SΣ | 0..1 | string | XPath expression of constraint |
| source | Σ | 0..1 | uri | Reference to original source of constraint |
| isModifier | Σ | 0..1 | boolean | If this modifies the meaning of other elements |
| isSummary | Σ | 0..1 | boolean | Include when _summary = true? |
| binding | SΣI | 0..1 | Element | ValueSet details if this is coded |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| strength | SΣ | 1..1 | code | required | extensible | preferred | example Binding: BindingStrength (required) |
| description | SΣI | 0..1 | string | Human explanation of the value set |
| valueSetReference | SΣI | 1..1 | Reference(Structured Data Capture Data Element Exchange Value Set) | Source of value set 3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-permitted-value-valueset | S | 0..1 | Reference(ValueSet) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset" | |
| valueReference | 0..1 | Reference(ValueSet) | Value of extension | |
| 11179-permitted-value-conceptmap | S | 0..1 | Reference(ConceptMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap" | |
| valueReference | 0..1 | Reference(ConceptMap) | Value of extension | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| mapping | SΣI | 0..1 | Element | Map element to another set of definitions |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| 11179-objectClass | S | 1..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-objectClass Binding: DataElement SDC Object Class (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-objectClass" | |
| valueCoding | S | 1..1 | Coding | Value of extension Binding: DataElement SDC Concept (extensible) |
| 11179-objectClassProperty | S | 1..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty Binding: DataElement SDC Object Class (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty" | |
| valueCoding | S | 1..1 | Coding | Value of extension Binding: DataElement SDC Concept (extensible) |
| identity | SΣ | 1..1 | id | Reference to mapping declaration Fixed Value: objclass-prop |
| language | Σ | 0..1 | code | Computable language of mapping Binding: IETF BCP-13 (required) |
| map | SΣ | string | Details of the mapping Slice: Unordered, Open by value:identity | |
| comment | Σ | 0..1 | string | Comments about the mapping or its use |
| mapping | SΣI | 0..* | Element | Map element to another set of definitions |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| elementdefinition-equivalence | S | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence Binding: ConceptMapEquivalence (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence" | |
| valueCode | 0..1 | code | Value of extension Binding: ConceptMapEquivalence (required) | |
| identity | SΣ | 1..1 | id | Reference to mapping declaration |
| language | SΣ | 0..1 | code | Computable language of mapping Binding: IETF BCP-13 (required) |
| map | SΣ | 1..1 | string | Details of the mapping |
| comment | Σ | 0..1 | string | Comments about the mapping or its use |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Name | Conformance | ValueSet |
| DataElement.language | Common Languages | extensible | Common Languages |
| DataElement.status | PublicationStatus | required | PublicationStatus |
| DataElement.useContext.extension.valueCode | ClassificationOrContext | required | ClassificationOrContext |
| DataElement.useContext.code | UsageContextType | extensible | UsageContextType |
| DataElement.useContext.value[x] | Context of Use ValueSet | example | Context of Use ValueSet |
| DataElement.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| DataElement.stringency | DataElementStringency | required | DataElementStringency |
| DataElement.element.extension.value[x] | UCUM Codes | required | UCUM Codes |
| DataElement.element.representation | PropertyRepresentation | required | PropertyRepresentation |
| DataElement.element.code | DataElement SDC Concept | extensible | DataElement SDC Concept |
| DataElement.element.slicing.discriminator.type | DiscriminatorType | required | DiscriminatorType |
| DataElement.element.slicing.rules | SlicingRules | required | SlicingRules |
| DataElement.element.type.aggregation | AggregationMode | required | AggregationMode |
| DataElement.element.type.versioning | ReferenceVersionRules | required | ReferenceVersionRules |
| DataElement.element.constraint.severity | ConstraintSeverity | required | ConstraintSeverity |
| DataElement.element.binding.strength | BindingStrength | required | BindingStrength |
| DataElement.element.mapping.extension.valueCoding | DataElement SDC Concept | extensible | DataElement SDC Concept |
| DataElement.element.mapping.extension.valueCoding | DataElement SDC Concept | extensible | DataElement SDC Concept |
| DataElement.element.mapping.language | ?ext | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| DataElement.element.mapping.extension.valueCode | ConceptMapEquivalence | required | ConceptMapEquivalence |
| DataElement.element.mapping.language | ?ext | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| Id | Path | Details | Requirements |
| dom-2 | DataElement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | DataElement | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | DataElement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | DataElement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | DataElement.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | DataElement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DataElement.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | DataElement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DataElement.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | DataElement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DataElement.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | DataElement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DataElement.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | DataElement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DataElement.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | DataElement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DataElement.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | DataElement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DataElement.mapping | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| dae-3 | DataElement.mapping | At least one of name or uri SHALL be present : uri.exists() or name.exists() | |
| ele-1 | DataElement.mapping | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| dae-3 | DataElement.mapping | At least one of name or uri SHALL be present : uri.exists() or name.exists() | |
| dae-1 | DataElement.element | No base allowed : base.empty() | |
| dae-2 | DataElement.element | No slicing allowed : slicing.empty() | |
| 2 | DataElement.element | One and only one DataElement.code must have is-data-element-concept set to "true" : code.extension(%ext-11179-de-is-data-element-concept).count = 1 | |
| ele-1 | DataElement.element.slicing.discriminator | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| eld-3 | DataElement.element.max | Max SHALL be a number or "*" : empty() or ($this = '*') or (toInteger() >= 0) | |
| ele-1 | DataElement.element.type | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| eld-4 | DataElement.element.type | Aggregation may only be specified if one of the allowed types for the element is a resource : aggregation.empty() or (code = 'Reference') | |
| ele-1 | DataElement.element.example | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | DataElement.element.constraint | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | DataElement.element.binding | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| eld-10 | DataElement.element.binding | provide either a reference or a description (or both) : valueSet.exists() or description.exists() | |
| eld-12 | DataElement.element.binding | ValueSet as a URI SHALL start with http:// or https:// or urn: : valueSet.is(uri).not() or valueSet.as(uri).startsWith('http:') or valueSet.as(uri).startsWith('https') or valueSet.as(uri).startsWith('urn:') | |
| 3 | DataElement.element.binding.valueSetReference | Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present : extension(%ext-11179-permitted-value-valueset).count() = extension(%ext-11179-permitted-value-conceptmap).count() | |
| ele-1 | DataElement.element.mapping | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | DataElement.element.mapping | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
© 2015+ HL7 International (OO work group). SDC-DE v2.0, based on FHIR v3.0.1. IG generated on Fri, Apr 21, 2017 10:24+1000.
Links: Version History |
Table of Contents |
|
Propose a change