extension shown: fhir [x]


Defined in the fhir.schema.org extension.
Canonical URL: http://schema.org/StructureDefinition

Thing > Resource > DomainResource > StructureDefinition
conformance.content > StructureDefinition

Base StructureDefinition for StructureDefinition Resource

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from StructureDefinition
StructureDefinition.abstract Boolean Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.
StructureDefinition.base Text An absolute URI that is the base structure from which this set of constraints is derived.
StructureDefinition.code Coding A set of terms from external terminologies that may be used to assist with indexing and searching of templates.
StructureDefinition.constrainedType defined-types The type of type that is being constrained - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is a constraint. If it is not present, then the structure definition is the definition of a base structure.
StructureDefinition.contact BackboneElement Contacts to assist a user in finding and communicating with the publisher.
StructureDefinition.contact.name Text The name of an individual to contact regarding the structure definition.
StructureDefinition.contact.telecom ContactPoint Contact details for individual (if a name was provided) or the publisher.
StructureDefinition.context Text Identifies the types of resource or data type elements to which the extension can be applied.
StructureDefinition.contextType extension-context If this is an extension, Identifies the context within FHIR resources where the extension can be used.
StructureDefinition.copyright Text A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.
StructureDefinition.date DateTime The date this version of the structure definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.
StructureDefinition.description Text A free text natural language description of the StructureDefinition and its use.
StructureDefinition.differential BackboneElement A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
StructureDefinition.differential.element ElementDefinition Captures constraints on each element within the resource.
StructureDefinition.display Text Defined so that applications can use this name when displaying the value of the extension to the user.
StructureDefinition.experimental Boolean This StructureDefinition was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
StructureDefinition.fhirVersion Text The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.
StructureDefinition.identifier Identifier Formal identifier that is used to identify this StructureDefinition when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).
StructureDefinition.kind structure-definition-kind Defines the kind of structure that this definition is describing.
StructureDefinition.mapping BackboneElement An external specification that the content is mapped to.
StructureDefinition.mapping.comments Text Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
StructureDefinition.mapping.identity Text An Internal id that is used to identify this mapping set when specific mappings are made.
StructureDefinition.mapping.name Text A name for the specification that is being mapped to.
StructureDefinition.mapping.uri Text An absolute URI that identifies the specification that this mapping is expressed to.
StructureDefinition.name Text A free text natural language name identifying the StructureDefinition.
StructureDefinition.publisher Text The name of the individual or organization that published the structure definition.
StructureDefinition.requirements Text Explains why this structure definition is needed and why it's been constrained as it has.
StructureDefinition.snapshot BackboneElement A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
StructureDefinition.snapshot.element ElementDefinition Captures constraints on each element within the resource.
StructureDefinition.status conformance-resource-status The status of the StructureDefinition.
StructureDefinition.url Text An absolute URL that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published.
StructureDefinition.useContext use-context The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of structure definitions.
StructureDefinition.version Text The identifier that is used to identify this version of the StructureDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureDefinition author manually.
Properties from DomainResource
DomainResource.contained Resource These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
DomainResource.extension Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
DomainResource.modifierExtension Extension May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
DomainResource.text Narrative A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Properties from Resource
Resource.id Text The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Resource.implicitRules Text A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Resource.language http://tools.ietf.org/html/bcp47 The base language in which the resource is written.
Resource.meta Meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
image URL  or
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
url URL URL of the item.

Instances of StructureDefinition may appear as values for the following properties
PropertyOn TypesDescription
ConceptMap.sourceReference ConceptMap The source value set that specifies the concepts that are being mapped.
ConceptMap.targetReference ConceptMap The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
Conformance.document.profile Conformance A constraint on a resource used in the document.
Conformance.messaging.event.request Conformance Information about the request for this event.
Conformance.messaging.event.response Conformance Information about the response for this event.
Conformance.profile Conformance A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles]{profiling.html#profile-uses}.
Conformance.rest.resource.profile Conformance A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles]{profiling.html#profile-uses}.
ImplementationGuide.global.profile ImplementationGuide A reference to the profile that all instances must conform to.
ImplementationGuide.package.resource.exampleFor ImplementationGuide Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.
OperationDefinition.parameter.profile OperationDefinition A profile the specifies the rules that this parameter must conform to.

Available supertypes defined in extensions

Schema Version 2.2