R4 Ballot #1 (Mixed Normative/Trial use)
ConformanceThis page is part of the FHIR Specification (v3.3.0: R4 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 
. Page versions: R5 R4B R4 R3 R2
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for structuredefinition
{
"resourceType": "StructureDefinition",
"id": "StructureDefinition",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 5
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"name": "StructureDefinition",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"description": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern"
},
{
"identity": "iso11179",
"uri": "http://metadata-standards.org/11179/",
"name": "ISO 11179"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "StructureDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "StructureDefinition",
"path": "StructureDefinition",
"short": "Structural Definition",
"definition": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.",
"alias": [
"Template",
"Profile"
],
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource"
},
{
"key": "sdf-9",
"requirements": "Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition",
"severity": "error",
"human": "In any snapshot or differential, no label, code or requirements on an element without a \".\" in the path (e.g. the first element)",
"expression": "children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()",
"xpath": "not(exists(f:snapshot/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)])) and not(exists(f:differential/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)]))"
},
{
"key": "sdf-19",
"requirements": "custom types only in logical models",
"severity": "error",
"human": "Custom types can only be used in logical models",
"expression": "kind = 'logical' or (differential.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')) and snapshot.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')))",
"xpath": "f:kind/@value = 'logical' or count(f:differential/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]|f:snapshot/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]) =0"
},
{
"key": "sdf-16",
"requirements": "element ids need to be unique",
"severity": "error",
"human": "All element definitions must have unique ids (snapshot)",
"expression": "snapshot.element.all(id) and snapshot.element.id.trace('ids').isDistinct()",
"xpath": "count(f:snapshot/f:element)=count(f:snapshot/f:element/@id) and (count(f:snapshot/f:element)=count(distinct-values(f:snapshot/f:element/@id)))"
},
{
"key": "sdf-18",
"requirements": "contextInvariant",
"severity": "error",
"human": "Context Invariants can only be used for extensions",
"expression": "contextInvariant.exists() implies type = 'Extension'",
"xpath": "not(exists(f:contextInvariant)) or (f:type/@value = 'Extension')"
},
{
"key": "sdf-17",
"requirements": "element ids need to be unique",
"severity": "error",
"human": "All element definitions must have unique ids (diff)",
"expression": "differential.element.all(id) and differential.element.id.trace('ids').isDistinct()",
"xpath": "count(f:differential/f:element)=count(f:differential/f:element/@id) and (count(f:differential/f:element)=count(distinct-values(f:differential/f:element/@id)))"
},
{
"key": "sdf-12",
"requirements": "Ensure that element.base appears with base or not",
"severity": "error",
"human": "element.base cannot appear if there is no base on the structure definition",
"expression": "snapshot.exists() implies (snapshot.element.base.exists() = baseDefinition.exists())",
"xpath": "f:baseDefinition or not(exists(f:snapshot/f:element/f:base) or exists(f:differential/f:element/f:base))"
},
{
"key": "sdf-11",
"requirements": "Ensure that the type is not inconsistent with the other information in the structure",
"severity": "error",
"human": "If there's a type, its content must match the path name in the first element of a snapshot",
"expression": "kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type",
"xpath": "(f:kind/@value = 'logical') or not(exists(f:snapshot)) or (f:type/@value = f:snapshot/f:element[1]/f:path/@value)"
},
{
"key": "sdf-14",
"requirements": "elements have id",
"severity": "error",
"human": "All element definitions must have an id",
"expression": "snapshot.element.all(id.exists()) and differential.element.all(id.exists())",
"xpath": "count(*/f:element)=count(*/f:element/@id)"
},
{
"key": "sdf-1",
"severity": "error",
"human": "Element paths must be unique unless the structure is a constraint",
"expression": "derivation = 'constraint' or snapshot.element.select(path).isDistinct()",
"xpath": "(f:derivation/@value = 'constraint') or (count(f:snapshot/f:element) = count(distinct-values(f:snapshot/f:element/f:path/@value)))"
},
{
"key": "sdf-21",
"requirements": "no default values on data types or resources",
"severity": "error",
"human": "Default values can only be specified on logical models",
"expression": "(snapshot.element.defaultValue.exists() or differential.element.defaultValue.exists()) implies ((kind = 'logical') and (derivation = 'specialization'))",
"xpath": "(not(exists(f:snapshot/f:element/*[starts-with(local-name(), 'defaultValue')])) and not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')]))) or ((f:kind/@value = 'logical') and (f:derivation/@value = 'specialization'))"
},
{
"key": "sdf-7",
"severity": "error",
"human": "If the structure describes a base Resource or Type, the URL has to start with \"http://hl7.org/fhir/StructureDefinition/\" and the tail must match the id",
"expression": "(derivation = 'constraint') or (kind = 'logical') or (url = 'http://hl7.org/fhir/StructureDefinition/'+id)",
"xpath": "(f:derivation/@value = 'constraint') or (f:kind/@value = 'logical') or (f:url/@value=concat('http://hl7.org/fhir/StructureDefinition/', f:id/@value))"
},
{
"key": "sdf-6",
"severity": "error",
"human": "A structure must have either a differential, or a snapshot (or both)",
"expression": "snapshot.exists() or differential.exists()",
"xpath": "exists(f:snapshot) or exists(f:differential)"
},
{
"key": "sdf-5",
"severity": "error",
"human": "If the structure defines an extension then the structure must have context information",
"expression": "type != 'Extension' or derivation = 'specialization' or (context.exists())",
"xpath": "not(f:type/@value = 'extension') or (f:derivation/@value = 'specialization') or (exists(f:context))"
},
{
"key": "sdf-4",
"requirements": "Ensure that the base types are abstract",
"severity": "error",
"human": "If the structure is not abstract, then there SHALL be a baseDefinition",
"expression": "abstract = true or baseDefinition.exists()",
"xpath": "(f:abstract/@value=true()) or exists(f:baseDefinition)"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.id",
"path": "StructureDefinition.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "StructureDefinition.meta",
"path": "StructureDefinition.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "StructureDefinition.implicitRules",
"path": "StructureDefinition.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "StructureDefinition.language",
"path": "StructureDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "StructureDefinition.text",
"path": "StructureDefinition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can 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.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "StructureDefinition.contained",
"path": "StructureDefinition.contained",
"short": "Contained, inline Resources",
"definition": "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.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureDefinition.extension",
"path": "StructureDefinition.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureDefinition.modifierExtension",
"path": "StructureDefinition.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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. 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureDefinition.url",
"path": "StructureDefinition.url",
"short": "Canonical identifier for this structure definition, represented as a URI (globally unique)",
"definition": "An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which this structure definition is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the structure definition to be referenced by a single globally unique identifier.",
"alias": [
"url",
"authoritative-url",
"destination",
"identity"
],
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "StructureDefinition.identifier",
"path": "StructureDefinition.identifier",
"short": "Additional identifier for the structure definition",
"definition": "A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "iso11179",
"map": "Identifier part"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "StructureDefinition.version",
"path": "StructureDefinition.version",
"short": "Business version of the structure definition",
"definition": "The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version].",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
},
{
"identity": "iso11179",
"map": "Version"
}
]
},
{
"id": "StructureDefinition.name",
"path": "StructureDefinition.name",
"short": "Name for this structure definition (computer friendly)",
"definition": "A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements": "Support human navigation and code generation.",
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "StructureDefinition.title",
"path": "StructureDefinition.title",
"short": "Name for this structure definition (human friendly)",
"definition": "A short, descriptive, user-friendly title for the structure definition.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.title",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.title"
}
]
},
{
"id": "StructureDefinition.status",
"path": "StructureDefinition.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this structure definition. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of structure definitions that are appropriate for use versus not.",
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "iso11179",
"map": "Registration status"
}
]
},
{
"id": "StructureDefinition.experimental",
"path": "StructureDefinition.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of structure definitions that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.experimental",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "iso11179",
"map": "Registration status"
}
]
},
{
"id": "StructureDefinition.date",
"path": "StructureDefinition.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "StructureDefinition.publisher",
"path": "StructureDefinition.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the structure definition.",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.publisher",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
},
{
"identity": "iso11179",
"map": "Registration Authority"
}
]
},
{
"id": "StructureDefinition.contact",
"path": "StructureDefinition.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition.contact",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactDetail"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "StructureDefinition.description",
"path": "StructureDefinition.description",
"short": "Natural language description of the structure definition",
"definition": "A free text natural language description of the structure definition from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the structure definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
}
]
},
{
"id": "StructureDefinition.useContext",
"path": "StructureDefinition.useContext",
"short": "The context that the content is intended to support",
"definition": "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 for appropriate structure definition instances.",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition.useContext",
"min": 0,
"max": "*"
},
"type": [
{
"code": "UsageContext"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "StructureDefinition.jurisdiction",
"path": "StructureDefinition.jurisdiction",
"short": "Intended jurisdiction for structure definition (if applicable)",
"definition": "A legal or geographic region in which the structure definition is intended to be used.",
"comment": "It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition.jurisdiction",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "StructureDefinition.purpose",
"path": "StructureDefinition.purpose",
"short": "Why this structure definition is defined",
"definition": "Explanation of why this structure definition is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.purpose",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "StructureDefinition.copyright",
"path": "StructureDefinition.copyright",
"short": "Use and/or publishing restrictions",
"definition": "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 structure definition.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.copyright",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.copyright"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "StructureDefinition.keyword",
"path": "StructureDefinition.keyword",
"short": "Assist with indexing and finding",
"definition": "A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.",
"requirements": "Assist in searching for appropriate StructureDefinitions.",
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition.keyword",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureDefinitionCode"
}
],
"strength": "example",
"description": "Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/profile-code"
},
"mapping": [
{
"identity": "iso11179",
"map": "keywords"
}
]
},
{
"id": "StructureDefinition.fhirVersion",
"path": "StructureDefinition.fhirVersion",
"short": "FHIR Version this StructureDefinition targets",
"definition": "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 3.3.0 for this version.",
"comment": "A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.fhirVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRVersions"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "All published FHIR Versions",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/fhir-versions"
}
},
{
"id": "StructureDefinition.mapping",
"path": "StructureDefinition.mapping",
"short": "External specification that the content is mapped to",
"definition": "An external specification that the content is mapped to.",
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition.mapping",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "sdf-2",
"severity": "error",
"human": "Must have at least a name or a uri (or both)",
"expression": "name.exists() or uri.exists()",
"xpath": "exists(f:uri) or exists(f:name)"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "StructureDefinition.mapping.id",
"path": "StructureDefinition.mapping.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.mapping.extension",
"path": "StructureDefinition.mapping.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.mapping.modifierExtension",
"path": "StructureDefinition.mapping.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureDefinition.mapping.identity",
"path": "StructureDefinition.mapping.identity",
"short": "Internal id when this mapping is used",
"definition": "An Internal id that is used to identify this mapping set when specific mappings are made.",
"comment": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.mapping.identity",
"min": 1,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "StructureDefinition.mapping.uri",
"path": "StructureDefinition.mapping.uri",
"short": "Identifies what this mapping refers to",
"definition": "An absolute URI that identifies the specification that this mapping is expressed to.",
"comment": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.mapping.uri",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"sdf-2"
],
"isModifier": false,
"isSummary": false
},
{
"id": "StructureDefinition.mapping.name",
"path": "StructureDefinition.mapping.name",
"short": "Names what this mapping refers to",
"definition": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.mapping.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"sdf-2"
],
"isModifier": false,
"isSummary": false
},
{
"id": "StructureDefinition.mapping.comment",
"path": "StructureDefinition.mapping.comment",
"short": "Versions, Issues, Scope limitations etc.",
"definition": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.mapping.comment",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "StructureDefinition.kind",
"path": "StructureDefinition.kind",
"short": "primitive-type | complex-type | resource | logical",
"definition": "Defines the kind of structure that this definition is describing.",
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.kind",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureDefinitionKind"
}
],
"strength": "required",
"description": "Defines the type of structure that a definition is describing.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/structure-definition-kind"
}
},
{
"id": "StructureDefinition.abstract",
"path": "StructureDefinition.abstract",
"short": "Whether the structure is abstract",
"definition": "Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.",
"comment": "Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of \"abstract\" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the profile, but have children described, are anonymous concrete types that specialize Element.",
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.abstract",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "StructureDefinition.context",
"path": "StructureDefinition.context",
"short": "If an extension, where it can be used in instances",
"definition": "Identifies the types of resource or data type elements to which the extension can be applied.",
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition.context",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"sdf-5"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "StructureDefinition.context.id",
"path": "StructureDefinition.context.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.context.extension",
"path": "StructureDefinition.context.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.context.modifierExtension",
"path": "StructureDefinition.context.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureDefinition.context.type",
"path": "StructureDefinition.context.type",
"short": "fhirpath | element | extension",
"definition": "Defines how to interpret the expression that defines what the context of the extension is.",
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.context.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ExtensionContextType"
}
],
"strength": "required",
"description": "How an extension context is interpreted.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/extension-context-type"
}
},
{
"id": "StructureDefinition.context.expression",
"path": "StructureDefinition.context.expression",
"short": "Where the extension can be used in instances",
"definition": "An expression that defines where an extension can be used in resources.",
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.context.expression",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "StructureDefinition.contextInvariant",
"path": "StructureDefinition.contextInvariant",
"short": "FHIRPath invariants - when the extension can be used",
"definition": "A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.",
"comment": "The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.",
"min": 0,
"max": "*",
"base": {
"path": "StructureDefinition.contextInvariant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"condition": [
"sdf-18"
],
"isModifier": false,
"isSummary": true
},
{
"id": "StructureDefinition.type",
"path": "StructureDefinition.type",
"short": "Type defined or constrained by this structure",
"definition": "The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.",
"comment": "Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a concrete structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. \n\nThe type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type is a URL, the type name SHOULD start with the tail of the type URL where required.",
"min": 1,
"max": "1",
"base": {
"path": "StructureDefinition.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"sdf-11"
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRDefinedTypeExt"
}
],
"strength": "extensible",
"description": "Either a resource or a data type, including logical model types",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/defined-types"
}
},
{
"id": "StructureDefinition.baseDefinition",
"path": "StructureDefinition.baseDefinition",
"short": "Definition that this type is constrained/specialized from",
"definition": "An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.",
"comment": "If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of \"Element\" or another logical model.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.baseDefinition",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": true
}
],
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
],
"condition": [
"sdf-4"
],
"isModifier": false,
"isSummary": true
},
{
"id": "StructureDefinition.derivation",
"path": "StructureDefinition.derivation",
"short": "specialization | constraint - How relates to base definition",
"definition": "How the type relates to the baseDefinition.",
"comment": "If the definition is a specialization, then it adds new elements in the differential, and the snapshot includes the inherited elements. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)).",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.derivation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TypeDerivationRule"
}
],
"strength": "required",
"description": "How a type relates to its baseDefinition.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/type-derivation-rule"
}
},
{
"id": "StructureDefinition.snapshot",
"path": "StructureDefinition.snapshot",
"short": "Snapshot view of the structure",
"definition": "A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.snapshot",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"sdf-6"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "sdf-15",
"requirements": "No Type on the root element (snapshot)",
"severity": "error",
"human": "The first element in a snapshot has no type",
"expression": "element.first().type.empty()",
"xpath": "not(f:element[1]/f:type)"
},
{
"key": "sdf-8",
"severity": "error",
"human": "In any snapshot, all the elements must be in the specified type, and must have a base definition",
"expression": "element.first().path = %resource.type and element.tail().all(path.startsWith(%resource.type&'.')) and element.all(base.exists())",
"xpath": "f:element[1]/f:path/@value=parent::f:StructureDefinition/f:type/@value and count(f:element[position()!=1])=count(f:element[position()!=1][starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])"
},
{
"key": "sdf-3",
"severity": "error",
"human": "Each element definition in a snapshot must have a formal definition and cardinalities",
"expression": "element.all(definition.exists() and min.exists() and max.exists())",
"xpath": "count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)])"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "StructureDefinition.snapshot.id",
"path": "StructureDefinition.snapshot.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.snapshot.extension",
"path": "StructureDefinition.snapshot.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.snapshot.modifierExtension",
"path": "StructureDefinition.snapshot.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureDefinition.snapshot.element",
"path": "StructureDefinition.snapshot.element",
"short": "Definition of elements in the resource (if no StructureDefinition)",
"definition": "Captures constraints on each element within the resource.",
"min": 1,
"max": "*",
"base": {
"path": "StructureDefinition.snapshot.element",
"min": 1,
"max": "*"
},
"type": [
{
"code": "ElementDefinition"
}
],
"condition": [
"sdf-3"
],
"constraint": [
{
"key": "sdf-10",
"requirements": "binding is required",
"severity": "error",
"human": "provide either a binding reference or a description (or both)",
"expression": "binding.empty() or binding.valueSet.exists() or binding.description.exists()",
"xpath": "not(exists(f:binding)) or (exists(f:binding/f:valueSetUri) or exists(f:binding/f:valueSetReference)) or exists(f:binding/f:description)"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "iso11179",
"map": "--"
}
]
},
{
"id": "StructureDefinition.differential",
"path": "StructureDefinition.differential",
"short": "Differential view of the structure",
"definition": "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.",
"min": 0,
"max": "1",
"base": {
"path": "StructureDefinition.differential",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"sdf-6"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "sdf-15a",
"requirements": "No Type on the root element (differential)",
"severity": "error",
"human": "If the first element in a differential has no \".\" in the path, it has no type",
"expression": "element.first().path.contains('.').not() implies element.first().type.empty()",
"xpath": "not(f:element[1][not(contains(f:path/@value, '.'))]/f:type)"
},
{
"key": "sdf-20",
"requirements": "no slicing on root",
"severity": "error",
"human": "No slicing on the root element",
"expression": "element.where(path.contains('.').not()).slicing.empty()",
"xpath": "not(f:element[1]/f:slicing)"
},
{
"key": "sdf-8a",
"severity": "error",
"human": "In any differential, all the elements must be in the specified type",
"expression": "element.first().path.startsWith(%resource.type) and element.tail().all(path.startsWith(%resource.type&'.'))",
"xpath": "count(f:element)=count(f:element[f:path/@value=ancestor::f:StructureDefinition/f:type/@value or starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "StructureDefinition.differential.id",
"path": "StructureDefinition.differential.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.differential.extension",
"path": "StructureDefinition.differential.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.differential.modifierExtension",
"path": "StructureDefinition.differential.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureDefinition.differential.element",
"path": "StructureDefinition.differential.element",
"short": "Definition of elements in the resource (if no StructureDefinition)",
"definition": "Captures constraints on each element within the resource.",
"min": 1,
"max": "*",
"base": {
"path": "StructureDefinition.differential.element",
"min": 1,
"max": "*"
},
"type": [
{
"code": "ElementDefinition"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "iso11179",
"map": "--"
}
]
}
]
},
"differential": {
"element": [
{
"id": "StructureDefinition",
"path": "StructureDefinition",
"short": "Structural Definition",
"definition": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.",
"alias": [
"Template",
"Profile"
],
"min": 0,
"max": "*",
"constraint": [
{
"key": "sdf-9",
"requirements": "Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition",
"severity": "error",
"human": "In any snapshot or differential, no label, code or requirements on an element without a \".\" in the path (e.g. the first element)",
"expression": "children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()",
"xpath": "not(exists(f:snapshot/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)])) and not(exists(f:differential/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)]))"
},
{
"key": "sdf-19",
"requirements": "custom types only in logical models",
"severity": "error",
"human": "Custom types can only be used in logical models",
"expression": "kind = 'logical' or (differential.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')) and snapshot.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')))",
"xpath": "f:kind/@value = 'logical' or count(f:differential/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]|f:snapshot/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$'))]) =0"
},
{
"key": "sdf-16",
"requirements": "element ids need to be unique",
"severity": "error",
"human": "All element definitions must have unique ids (snapshot)",
"expression": "snapshot.element.all(id) and snapshot.element.id.trace('ids').isDistinct()",
"xpath": "count(f:snapshot/f:element)=count(f:snapshot/f:element/@id) and (count(f:snapshot/f:element)=count(distinct-values(f:snapshot/f:element/@id)))"
},
{
"key": "sdf-18",
"requirements": "contextInvariant",
"severity": "error",
"human": "Context Invariants can only be used for extensions",
"expression": "contextInvariant.exists() implies type = 'Extension'",
"xpath": "not(exists(f:contextInvariant)) or (f:type/@value = 'Extension')"
},
{
"key": "sdf-17",
"requirements": "element ids need to be unique",
"severity": "error",
"human": "All element definitions must have unique ids (diff)",
"expression": "differential.element.all(id) and differential.element.id.trace('ids').isDistinct()",
"xpath": "count(f:differential/f:element)=count(f:differential/f:element/@id) and (count(f:differential/f:element)=count(distinct-values(f:differential/f:element/@id)))"
},
{
"key": "sdf-12",
"requirements": "Ensure that element.base appears with base or not",
"severity": "error",
"human": "element.base cannot appear if there is no base on the structure definition",
"expression": "snapshot.exists() implies (snapshot.element.base.exists() = baseDefinition.exists())",
"xpath": "f:baseDefinition or not(exists(f:snapshot/f:element/f:base) or exists(f:differential/f:element/f:base))"
},
{
"key": "sdf-11",
"requirements": "Ensure that the type is not inconsistent with the other information in the structure",
"severity": "error",
"human": "If there's a type, its content must match the path name in the first element of a snapshot",
"expression": "kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type",
"xpath": "(f:kind/@value = 'logical') or not(exists(f:snapshot)) or (f:type/@value = f:snapshot/f:element[1]/f:path/@value)"
},
{
"key": "sdf-14",
"requirements": "elements have id",
"severity": "error",
"human": "All element definitions must have an id",
"expression": "snapshot.element.all(id.exists()) and differential.element.all(id.exists())",
"xpath": "count(*/f:element)=count(*/f:element/@id)"
},
{
"key": "sdf-1",
"severity": "error",
"human": "Element paths must be unique unless the structure is a constraint",
"expression": "derivation = 'constraint' or snapshot.element.select(path).isDistinct()",
"xpath": "(f:derivation/@value = 'constraint') or (count(f:snapshot/f:element) = count(distinct-values(f:snapshot/f:element/f:path/@value)))"
},
{
"key": "sdf-21",
"requirements": "no default values on data types or resources",
"severity": "error",
"human": "Default values can only be specified on logical models",
"expression": "(snapshot.element.defaultValue.exists() or differential.element.defaultValue.exists()) implies ((kind = 'logical') and (derivation = 'specialization'))",
"xpath": "(not(exists(f:snapshot/f:element/*[starts-with(local-name(), 'defaultValue')])) and not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')]))) or ((f:kind/@value = 'logical') and (f:derivation/@value = 'specialization'))"
},
{
"key": "sdf-7",
"severity": "error",
"human": "If the structure describes a base Resource or Type, the URL has to start with \"http://hl7.org/fhir/StructureDefinition/\" and the tail must match the id",
"expression": "(derivation = 'constraint') or (kind = 'logical') or (url = 'http://hl7.org/fhir/StructureDefinition/'+id)",
"xpath": "(f:derivation/@value = 'constraint') or (f:kind/@value = 'logical') or (f:url/@value=concat('http://hl7.org/fhir/StructureDefinition/', f:id/@value))"
},
{
"key": "sdf-6",
"severity": "error",
"human": "A structure must have either a differential, or a snapshot (or both)",
"expression": "snapshot.exists() or differential.exists()",
"xpath": "exists(f:snapshot) or exists(f:differential)"
},
{
"key": "sdf-5",
"severity": "error",
"human": "If the structure defines an extension then the structure must have context information",
"expression": "type != 'Extension' or derivation = 'specialization' or (context.exists())",
"xpath": "not(f:type/@value = 'extension') or (f:derivation/@value = 'specialization') or (exists(f:context))"
},
{
"key": "sdf-4",
"requirements": "Ensure that the base types are abstract",
"severity": "error",
"human": "If the structure is not abstract, then there SHALL be a baseDefinition",
"expression": "abstract = true or baseDefinition.exists()",
"xpath": "(f:abstract/@value=true()) or exists(f:baseDefinition)"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureDefinition.url",
"path": "StructureDefinition.url",
"short": "Canonical identifier for this structure definition, represented as a URI (globally unique)",
"definition": "An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which this structure definition is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the structure definition to be referenced by a single globally unique identifier.",
"alias": [
"url",
"authoritative-url",
"destination",
"identity"
],
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "StructureDefinition.identifier",
"path": "StructureDefinition.identifier",
"short": "Additional identifier for the structure definition",
"definition": "A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "iso11179",
"map": "Identifier part"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "StructureDefinition.version",
"path": "StructureDefinition.version",
"short": "Business version of the structure definition",
"definition": "The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
},
{
"identity": "iso11179",
"map": "Version"
}
]
},
{
"id": "StructureDefinition.name",
"path": "StructureDefinition.name",
"short": "Name for this structure definition (computer friendly)",
"definition": "A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements": "Support human navigation and code generation.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureDefinition.title",
"path": "StructureDefinition.title",
"short": "Name for this structure definition (human friendly)",
"definition": "A short, descriptive, user-friendly title for the structure definition.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.title"
}
]
},
{
"id": "StructureDefinition.status",
"path": "StructureDefinition.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this structure definition. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of structure definitions that are appropriate for use versus not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "iso11179",
"map": "Registration status"
}
]
},
{
"id": "StructureDefinition.experimental",
"path": "StructureDefinition.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of structure definitions that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "iso11179",
"map": "Registration status"
}
]
},
{
"id": "StructureDefinition.date",
"path": "StructureDefinition.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "StructureDefinition.publisher",
"path": "StructureDefinition.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the structure definition.",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
},
{
"identity": "iso11179",
"map": "Registration Authority"
}
]
},
{
"id": "StructureDefinition.contact",
"path": "StructureDefinition.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "StructureDefinition.description",
"path": "StructureDefinition.description",
"short": "Natural language description of the structure definition",
"definition": "A free text natural language description of the structure definition from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the structure definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
}
]
},
{
"id": "StructureDefinition.useContext",
"path": "StructureDefinition.useContext",
"short": "The context that the content is intended to support",
"definition": "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 for appropriate structure definition instances.",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "StructureDefinition.jurisdiction",
"path": "StructureDefinition.jurisdiction",
"short": "Intended jurisdiction for structure definition (if applicable)",
"definition": "A legal or geographic region in which the structure definition is intended to be used.",
"comment": "It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "StructureDefinition.purpose",
"path": "StructureDefinition.purpose",
"short": "Why this structure definition is defined",
"definition": "Explanation of why this structure definition is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "StructureDefinition.copyright",
"path": "StructureDefinition.copyright",
"short": "Use and/or publishing restrictions",
"definition": "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 structure definition.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.copyright"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "StructureDefinition.keyword",
"path": "StructureDefinition.keyword",
"short": "Assist with indexing and finding",
"definition": "A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.",
"requirements": "Assist in searching for appropriate StructureDefinitions.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureDefinitionCode"
}
],
"strength": "example",
"description": "Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/profile-code"
},
"mapping": [
{
"identity": "iso11179",
"map": "keywords"
}
]
},
{
"id": "StructureDefinition.fhirVersion",
"path": "StructureDefinition.fhirVersion",
"short": "FHIR Version this StructureDefinition targets",
"definition": "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 3.3.0 for this version.",
"comment": "A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRVersions"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "All published FHIR Versions",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/fhir-versions"
}
},
{
"id": "StructureDefinition.mapping",
"path": "StructureDefinition.mapping",
"short": "External specification that the content is mapped to",
"definition": "An external specification that the content is mapped to.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "sdf-2",
"severity": "error",
"human": "Must have at least a name or a uri (or both)",
"expression": "name.exists() or uri.exists()",
"xpath": "exists(f:uri) or exists(f:name)"
}
]
},
{
"id": "StructureDefinition.mapping.identity",
"path": "StructureDefinition.mapping.identity",
"short": "Internal id when this mapping is used",
"definition": "An Internal id that is used to identify this mapping set when specific mappings are made.",
"comment": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"id": "StructureDefinition.mapping.uri",
"path": "StructureDefinition.mapping.uri",
"short": "Identifies what this mapping refers to",
"definition": "An absolute URI that identifies the specification that this mapping is expressed to.",
"comment": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"condition": [
"sdf-2"
]
},
{
"id": "StructureDefinition.mapping.name",
"path": "StructureDefinition.mapping.name",
"short": "Names what this mapping refers to",
"definition": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sdf-2"
]
},
{
"id": "StructureDefinition.mapping.comment",
"path": "StructureDefinition.mapping.comment",
"short": "Versions, Issues, Scope limitations etc.",
"definition": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "StructureDefinition.kind",
"path": "StructureDefinition.kind",
"short": "primitive-type | complex-type | resource | logical",
"definition": "Defines the kind of structure that this definition is describing.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureDefinitionKind"
}
],
"strength": "required",
"description": "Defines the type of structure that a definition is describing.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/structure-definition-kind"
}
},
{
"id": "StructureDefinition.abstract",
"path": "StructureDefinition.abstract",
"short": "Whether the structure is abstract",
"definition": "Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.",
"comment": "Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of \"abstract\" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the profile, but have children described, are anonymous concrete types that specialize Element.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "StructureDefinition.context",
"path": "StructureDefinition.context",
"short": "If an extension, where it can be used in instances",
"definition": "Identifies the types of resource or data type elements to which the extension can be applied.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"sdf-5"
],
"isSummary": true
},
{
"id": "StructureDefinition.context.type",
"path": "StructureDefinition.context.type",
"short": "fhirpath | element | extension",
"definition": "Defines how to interpret the expression that defines what the context of the extension is.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ExtensionContextType"
}
],
"strength": "required",
"description": "How an extension context is interpreted.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/extension-context-type"
}
},
{
"id": "StructureDefinition.context.expression",
"path": "StructureDefinition.context.expression",
"short": "Where the extension can be used in instances",
"definition": "An expression that defines where an extension can be used in resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureDefinition.contextInvariant",
"path": "StructureDefinition.contextInvariant",
"short": "FHIRPath invariants - when the extension can be used",
"definition": "A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.",
"comment": "The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"condition": [
"sdf-18"
],
"isSummary": true
},
{
"id": "StructureDefinition.type",
"path": "StructureDefinition.type",
"short": "Type defined or constrained by this structure",
"definition": "The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.",
"comment": "Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a concrete structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. \n\nThe type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type is a URL, the type name SHOULD start with the tail of the type URL where required.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"condition": [
"sdf-11"
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRDefinedTypeExt"
}
],
"strength": "extensible",
"description": "Either a resource or a data type, including logical model types",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/defined-types"
}
},
{
"id": "StructureDefinition.baseDefinition",
"path": "StructureDefinition.baseDefinition",
"short": "Definition that this type is constrained/specialized from",
"definition": "An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.",
"comment": "If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of \"Element\" or another logical model.",
"min": 0,
"max": "1",
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": true
}
],
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
],
"condition": [
"sdf-4"
],
"isSummary": true
},
{
"id": "StructureDefinition.derivation",
"path": "StructureDefinition.derivation",
"short": "specialization | constraint - How relates to base definition",
"definition": "How the type relates to the baseDefinition.",
"comment": "If the definition is a specialization, then it adds new elements in the differential, and the snapshot includes the inherited elements. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "TypeDerivationRule"
}
],
"strength": "required",
"description": "How a type relates to its baseDefinition.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/type-derivation-rule"
}
},
{
"id": "StructureDefinition.snapshot",
"path": "StructureDefinition.snapshot",
"short": "Snapshot view of the structure",
"definition": "A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"sdf-6"
],
"constraint": [
{
"key": "sdf-15",
"requirements": "No Type on the root element (snapshot)",
"severity": "error",
"human": "The first element in a snapshot has no type",
"expression": "element.first().type.empty()",
"xpath": "not(f:element[1]/f:type)"
},
{
"key": "sdf-8",
"severity": "error",
"human": "In any snapshot, all the elements must be in the specified type, and must have a base definition",
"expression": "element.first().path = %resource.type and element.tail().all(path.startsWith(%resource.type&'.')) and element.all(base.exists())",
"xpath": "f:element[1]/f:path/@value=parent::f:StructureDefinition/f:type/@value and count(f:element[position()!=1])=count(f:element[position()!=1][starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])"
},
{
"key": "sdf-3",
"severity": "error",
"human": "Each element definition in a snapshot must have a formal definition and cardinalities",
"expression": "element.all(definition.exists() and min.exists() and max.exists())",
"xpath": "count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)])"
}
]
},
{
"id": "StructureDefinition.snapshot.element",
"path": "StructureDefinition.snapshot.element",
"short": "Definition of elements in the resource (if no StructureDefinition)",
"definition": "Captures constraints on each element within the resource.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"condition": [
"sdf-3"
],
"constraint": [
{
"key": "sdf-10",
"requirements": "binding is required",
"severity": "error",
"human": "provide either a binding reference or a description (or both)",
"expression": "binding.empty() or binding.valueSet.exists() or binding.description.exists()",
"xpath": "not(exists(f:binding)) or (exists(f:binding/f:valueSetUri) or exists(f:binding/f:valueSetReference)) or exists(f:binding/f:description)"
}
],
"mapping": [
{
"identity": "iso11179",
"map": "--"
}
]
},
{
"id": "StructureDefinition.differential",
"path": "StructureDefinition.differential",
"short": "Differential view of the structure",
"definition": "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"sdf-6"
],
"constraint": [
{
"key": "sdf-15a",
"requirements": "No Type on the root element (differential)",
"severity": "error",
"human": "If the first element in a differential has no \".\" in the path, it has no type",
"expression": "element.first().path.contains('.').not() implies element.first().type.empty()",
"xpath": "not(f:element[1][not(contains(f:path/@value, '.'))]/f:type)"
},
{
"key": "sdf-20",
"requirements": "no slicing on root",
"severity": "error",
"human": "No slicing on the root element",
"expression": "element.where(path.contains('.').not()).slicing.empty()",
"xpath": "not(f:element[1]/f:slicing)"
},
{
"key": "sdf-8a",
"severity": "error",
"human": "In any differential, all the elements must be in the specified type",
"expression": "element.first().path.startsWith(%resource.type) and element.tail().all(path.startsWith(%resource.type&'.'))",
"xpath": "count(f:element)=count(f:element[f:path/@value=ancestor::f:StructureDefinition/f:type/@value or starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])"
}
]
},
{
"id": "StructureDefinition.differential.element",
"path": "StructureDefinition.differential.element",
"short": "Definition of elements in the resource (if no StructureDefinition)",
"definition": "Captures constraints on each element within the resource.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"mapping": [
{
"identity": "iso11179",
"map": "--"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:18+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change