Showing:

Annotations
Attributes
Diagrams
Facets
Model
Properties
Source
Used by
Complex Type StructureDefinitionType
Namespace No namespace
Annotations
Structure definition wrapper: wraps FHIR StructureDefinition either as the source or as a reference, and holds enough information to manage it.
Diagram
DiagramDECOR_xsd_Complex_Type_StructureDefinitionType.tmp#StructureDefinitionType_idDECOR_xsd_Attribute_canonicalUri.tmp#canonicalUriDECOR_xsd_Complex_Type_StructureDefinitionType.tmp#StructureDefinitionType_refDECOR_xsd_Complex_Type_StructureDefinitionType.tmp#StructureDefinitionType_nameDECOR_xsd_Complex_Type_StructureDefinitionType.tmp#StructureDefinitionType_linkDECOR_xsd_Attribute_Group_VersionHandlingEffectiveDateOptional.tmp#VersionHandlingEffectiveDateOptionalDECOR_xsd_Complex_Type_StructureDefinitionType.tmp#StructureDefinitionType_statusCodeDECOR_xsd_Attribute_displayName.tmp#displayNameDECOR_xsd_Complex_Type_StructureDefinitionType.tmp#StructureDefinitionType_flexibility
Used by
Model
(ANY element from namespace(s) 'http://hl7.org/fhir')
Attributes
QName Type Use Annotation
canonicalUri xs:anyURI optional
HL7® FHIR® canonical URI. Logical URI to reference this StructureDefinition, logical model, value set, etc. (globally unique)
HL7® FHIR® canonical URI. Logical URI to reference this StructureDefinition, logical model, value set, etc. (globally unique)
HL7® FHIR® kanonieke URI. Logische URI om te verwijzen naar deze StructureDefinition, dit logisch model, waardelijst, etc. (wereldwijd uniek)
displayName NonEmptyString optional
A short description string for the designation
effectiveDate TimeStampNoTimezone optional
Identifies the effective date of the version of the object.
expirationDate TimeStampNoTimezone optional
Identifies the expiration date of the version of the object.
flexibility StaticOrDynamicFlexibility optional
Not in use yet: Reference to a StructureDefinition Wrapper. Default is unspecified which means 'latest available version'.
id Oid optional
The identifying OID of the StructureDefinition Wrapper
lastModifiedDate TimeStampNoTimezone optional
Identifies last point in time that the object was changed.
link xs:anyURI optional
If the FHIR StructureDefinition is contained as a reference, this link points to the source
name ShortFormalName required
The mnemonic name of the StructureDefinition
officialReleaseDate TimeStampNoTimezone optional
Identifies the official release date of the version of the object.
ref Oid optional
Not in use yet: Reference to a StructureDefinition Wrapper @id. StructureDefinition Wrappers SHALL carry either @id or @ref
statusCode TemplateStatusCodeLifeCycle optional
versionLabel ShortDescriptiveName optional
A human readable version number or version label for convenient human rendition; not used by an application.
Source
<xs:complexType name="StructureDefinitionType">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Structure definition wrapper: wraps FHIR StructureDefinition either as the source or as a reference, and holds enough information to manage it.</xs:documentation>
    <xs:appinfo>
      <xforms:label xml:lang="nl-NL">StructureDefinition Wrapper</xforms:label>
      <xforms:label xml:lang="en-US">StructureDefinition Wrapper</xforms:label>
      <xforms:label xml:lang="de-DE">StructureDefinition Wrapper</xforms:label>
    </xs:appinfo>
  </xs:annotation>
  <xs:sequence>
    <xs:choice maxOccurs="1">
      <!-- FHIR object -->
      <xs:any namespace="http://hl7.org/fhir" minOccurs="0" maxOccurs="1" processContents="skip">
        <xs:annotation>
          <xs:documentation xml:lang="en-US">If the FHIR StructureDefinition is contained as the source it goes here</xs:documentation>
        </xs:annotation>
      </xs:any>
    </xs:choice>
  </xs:sequence>
  <xs:attribute name="id" type="Oid" use="optional">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">The identifying OID of the StructureDefinition Wrapper</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute ref="canonicalUri" use="optional"/>
  <xs:attribute name="ref" type="Oid" use="optional">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">Not in use yet: Reference to a StructureDefinition Wrapper @id. StructureDefinition Wrappers SHALL carry either @id or @ref</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="name" type="ShortFormalName" use="required">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">The mnemonic name of the StructureDefinition</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="link" type="xs:anyURI" use="optional">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">If the FHIR StructureDefinition is contained as a reference, this link points to the source</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <!-- attributes of StructureDefinition (validation done by embedded schematron) -->
  <xs:attributeGroup ref="VersionHandlingEffectiveDateOptional"/>
  <xs:attribute name="statusCode" type="TemplateStatusCodeLifeCycle" use="optional"/>
  <xs:attribute ref="displayName" use="optional"/>
  <!-- if @ref, flexibility -->
  <xs:attribute name="flexibility" type="StaticOrDynamicFlexibility" use="optional">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">Not in use yet: Reference to a StructureDefinition Wrapper. Default is unspecified which means 'latest available version'.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>
Attribute StructureDefinitionType / @id
Namespace No namespace
Annotations
The identifying OID of the StructureDefinition Wrapper
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Source
<xs:attribute name="id" type="Oid" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">The identifying OID of the StructureDefinition Wrapper</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute StructureDefinitionType / @ref
Namespace No namespace
Annotations
Not in use yet: Reference to a StructureDefinition Wrapper @id. StructureDefinition Wrappers SHALL carry either @id or @ref
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Source
<xs:attribute name="ref" type="Oid" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Not in use yet: Reference to a StructureDefinition Wrapper @id. StructureDefinition Wrappers SHALL carry either @id or @ref</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute StructureDefinitionType / @name
Namespace No namespace
Annotations
The mnemonic name of the StructureDefinition
Type ShortFormalName
Properties
use required
Facets
maxLength 80
pattern (\c+) & ([A-Za-z]+([A-Za-z0-9,.,\-,_])*)
Used by
Source
<xs:attribute name="name" type="ShortFormalName" use="required">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">The mnemonic name of the StructureDefinition</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute StructureDefinitionType / @link
Namespace No namespace
Annotations
Type xs:anyURI
Properties
Used by
Source
Attribute StructureDefinitionType / @statusCode
Namespace No namespace
Type TemplateStatusCodeLifeCycle
Type hierarchy
Properties
use optional
Facets
maxLength 50
enumeration draft
Template under development (nascent). Metadata and template may be incomplete. Entered primarily to encourage other users to be aware of ongoing
process.
enumeration active
Template has been published by the governance group (custodian organization) and deemed fit for use. May have associated adoption and annotation metadata.
enumeration retired
Template retired: No longer fit for use. Information available for historical reference.
enumeration rejected
Template is rejected. During the development proces of a template design (new, draft) it was decided that
further development on this template will not happen.
enumeration cancelled
Template was never published and is withdrawn.
enumeration pending
Template is in pre-publication review: the template is complete, pending appropriate review. Entered primarily to encourage other users to be
aware of and/or participate in the review process. The governance group (custodian organization) has not given it an "active" status (i.e. it has not been published); 
and it may still be rejected (transitioned to an inactive status)., e.g. the template may be under ballot by an SDO.
enumeration review
Template is in review: a post-publication state; may result in a new version or a retirement or no change at all. 
A new version is one that adds clarity but not new intent (new version date but identifier is unchanged).
A retirement is a template that is no longer fit for purpose, and which
may be replaced by a different a template (version), which is linked to the retired template.
Used by
Source
<xs:attribute name="statusCode" type="TemplateStatusCodeLifeCycle" use="optional"/>
Attribute StructureDefinitionType / @flexibility
Namespace No namespace
Annotations
Not in use yet: Reference to a StructureDefinition Wrapper. Default is unspecified which means 'latest available version'.
Type StaticOrDynamicFlexibility
Properties
use optional
Used by
Source
<xs:attribute name="flexibility" type="StaticOrDynamicFlexibility" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Not in use yet: Reference to a StructureDefinition Wrapper. Default is unspecified which means 'latest available version'.</xs:documentation>
  </xs:annotation>
</xs:attribute>