FHIR Release 3 (STU)
Implementation SupportThis page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for structuremap
{
"resourceType": "StructureDefinition",
"id": "StructureMap",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/StructureMap",
"name": "StructureMap",
"status": "draft",
"date": "2019-10-24T11:53:00+11: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": "Base StructureDefinition for StructureMap Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "StructureMap",
"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": "StructureMap",
"path": "StructureMap",
"short": "A Map of relationships between 2 structures that can be used to transform data",
"definition": "A Map of relationships between 2 structures that can be used to transform data.",
"alias": [
"Template",
"Profile"
],
"min": 1,
"max": "1",
"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",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.content"
}
]
},
{
"id": "StructureMap.id",
"path": "StructureMap.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"
}
],
"isSummary": true
},
{
"id": "StructureMap.meta",
"path": "StructureMap.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 may 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"
}
],
"isSummary": true
},
{
"id": "StructureMap.implicitRules",
"path": "StructureMap.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.",
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "StructureMap.language",
"path": "StructureMap.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"
}
],
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "StructureMap.text",
"path": "StructureMap.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"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"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "StructureMap.contained",
"path": "StructureMap.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.extension",
"path": "StructureMap.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.modifierExtension",
"path": "StructureMap.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.url",
"path": "StructureMap.url",
"short": "Logical URI to reference this structure map (globally unique)",
"definition": "An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure map is (or will be) published. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).",
"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.",
"requirements": "Allows the structure map 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": "w5",
"map": "id"
}
]
},
{
"id": "StructureMap.identifier",
"path": "StructureMap.identifier",
"short": "Additional identifier for the structure map",
"definition": "A formal identifier that is used to identify this structure map 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, e.g., to identify this structure map 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": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "StructureMap.version",
"path": "StructureMap.version",
"short": "Business version of the structure map",
"definition": "The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map 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 map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the structure map with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "StructureMap.name",
"path": "StructureMap.name",
"short": "Name for this structure map (computer friendly)",
"definition": "A natural language name identifying the structure map. 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 alpha-numeric type name to ensure that it is computable friendly.",
"requirements": "Support human navigation and code generation.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.title",
"path": "StructureMap.title",
"short": "Name for this structure map (human friendly)",
"definition": "A short, descriptive, user-friendly title for the structure map.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.status",
"path": "StructureMap.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this structure map. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of structure maps that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired structure map without due consideration.",
"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 a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "StructureMap.experimental",
"path": "StructureMap.experimental",
"short": "For testing purposes, not real usage",
"definition": "A boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comment": "Allows filtering of structure map that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental structure map in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure map.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "StructureMap.date",
"path": "StructureMap.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the structure map was published. The date must change if and 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 map 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 map. 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": "w5",
"map": "when.recorded"
}
]
},
{
"id": "StructureMap.publisher",
"path": "StructureMap.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the structure map.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the structure map is the organization or individual primarily responsible for the maintenance and upkeep of the structure map. 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 map. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the structure map. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "StructureMap.contact",
"path": "StructureMap.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
},
{
"id": "StructureMap.description",
"path": "StructureMap.description",
"short": "Natural language description of the structure map",
"definition": "A free text natural language description of the structure map from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the structure map 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 map 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"
}
]
},
{
"id": "StructureMap.useContext",
"path": "StructureMap.useContext",
"short": "Context 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 map instances.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "StructureMap.jurisdiction",
"path": "StructureMap.jurisdiction",
"short": "Intended jurisdiction for structure map (if applicable)",
"definition": "A legal or geographic region in which the structure map is intended to be used.",
"comment": "It may be possible for the structure map 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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "StructureMap.purpose",
"path": "StructureMap.purpose",
"short": "Why this structure map is defined",
"definition": "Explaination of why this structure map is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the structure map 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 map.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "StructureMap.copyright",
"path": "StructureMap.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the structure map and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "StructureMap.structure",
"path": "StructureMap.structure",
"short": "Structure Definition used by this map",
"definition": "A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.",
"comment": "It is not necessary for a structure map to identify any dependent structures, though not losting them may restrict its usefulness.",
"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"
}
],
"isSummary": true
},
{
"id": "StructureMap.structure.id",
"path": "StructureMap.structure.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.structure.extension",
"path": "StructureMap.structure.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.structure.modifierExtension",
"path": "StructureMap.structure.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.structure.url",
"path": "StructureMap.structure.url",
"short": "Canonical URL for structure definition",
"definition": "The canonical URL that identifies the structure.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "StructureMap.structure.mode",
"path": "StructureMap.structure.mode",
"short": "source | queried | target | produced",
"definition": "How the referenced structure is used in this mapping.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapModelMode"
}
],
"strength": "required",
"description": "How the referenced structure is used in this mapping",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-model-mode"
}
}
},
{
"id": "StructureMap.structure.alias",
"path": "StructureMap.structure.alias",
"short": "Name for type in this map",
"definition": "The name used for this type in the map.",
"comment": "This is needed if both types have the same name (e.g. version conversion).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.structure.documentation",
"path": "StructureMap.structure.documentation",
"short": "Documentation on use of structure",
"definition": "Documentation that describes how the structure is used in the mapping.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "StructureMap.import",
"path": "StructureMap.import",
"short": "Other maps used by this map (canonical URLs)",
"definition": "Other maps used by this map (canonical URLs).",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "StructureMap.group",
"path": "StructureMap.group",
"short": "Named sections for reader convenience",
"definition": "Organizes the mapping into managable chunks for human review/ease of maintenance.",
"min": 1,
"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"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.id",
"path": "StructureMap.group.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.extension",
"path": "StructureMap.group.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.modifierExtension",
"path": "StructureMap.group.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.group.name",
"path": "StructureMap.group.name",
"short": "Human-readable label",
"definition": "A unique name for the group for the convenience of human readers.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.extends",
"path": "StructureMap.group.extends",
"short": "Another group that this group adds rules to",
"definition": "Another group that this group adds rules to.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.typeMode",
"path": "StructureMap.group.typeMode",
"short": "none | types | type-and-types",
"definition": "If this is the default rule set to apply for thie source type, or this combination of types.",
"comment": "Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapGroupTypeMode"
}
],
"strength": "required",
"description": "If this is the default rule set to apply for the source type, or this combination of types",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-group-type-mode"
}
}
},
{
"id": "StructureMap.group.documentation",
"path": "StructureMap.group.documentation",
"short": "Additional description/explaination for group",
"definition": "Additional supporting documentation that explains the purpose of the group and the types of mappings within it.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.input",
"path": "StructureMap.group.input",
"short": "Named instance provided when invoking the map",
"definition": "A name assigned to an instance of data. The instance must be provided when the mapping is invoked.",
"comment": "If no inputs are named, then the entry mappings are type based.",
"min": 1,
"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"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.input.id",
"path": "StructureMap.group.input.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.input.extension",
"path": "StructureMap.group.input.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.input.modifierExtension",
"path": "StructureMap.group.input.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.group.input.name",
"path": "StructureMap.group.input.name",
"short": "Name for this instance of data",
"definition": "Name for this instance of data.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.input.type",
"path": "StructureMap.group.input.type",
"short": "Type for this instance of data",
"definition": "Type for this instance of data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.input.mode",
"path": "StructureMap.group.input.mode",
"short": "source | target",
"definition": "Mode for this instance of data.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapInputMode"
}
],
"strength": "required",
"description": "Mode for this instance of data",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-input-mode"
}
}
},
{
"id": "StructureMap.group.input.documentation",
"path": "StructureMap.group.input.documentation",
"short": "Documentation for this instance of data",
"definition": "Documentation for this instance of data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "StructureMap.group.rule",
"path": "StructureMap.group.rule",
"short": "Transform Rule from source to target",
"definition": "Transform Rule from source to target.",
"min": 1,
"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"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.id",
"path": "StructureMap.group.rule.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.extension",
"path": "StructureMap.group.rule.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.modifierExtension",
"path": "StructureMap.group.rule.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.group.rule.name",
"path": "StructureMap.group.rule.name",
"short": "Name of the rule for internal references",
"definition": "Name of the rule for internal references.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source",
"path": "StructureMap.group.rule.source",
"short": "Source inputs to the mapping",
"definition": "Source inputs to the mapping.",
"min": 1,
"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"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.id",
"path": "StructureMap.group.rule.source.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.source.extension",
"path": "StructureMap.group.rule.source.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.source.modifierExtension",
"path": "StructureMap.group.rule.source.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.group.rule.source.context",
"path": "StructureMap.group.rule.source.context",
"short": "Type or variable this rule applies to",
"definition": "Type or variable this rule applies to.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.min",
"path": "StructureMap.group.rule.source.min",
"short": "Specified minimum cardinality",
"definition": "Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.max",
"path": "StructureMap.group.rule.source.max",
"short": "Specified maximum cardinality (number or *)",
"definition": "Specified maximum cardinality for the element - a number or a \"*\". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.type",
"path": "StructureMap.group.rule.source.type",
"short": "Rule only applies if source has this type",
"definition": "Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.defaultValue[x]",
"path": "StructureMap.group.rule.source.defaultValue[x]",
"short": "Default value if no value exists",
"definition": "A value to use if there is no existing value in the source object.",
"comment": "If there's a default value on an item that can repeat, it will only be used once.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.element",
"path": "StructureMap.group.rule.source.element",
"short": "Optional field for this source",
"definition": "Optional field for this source.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.listMode",
"path": "StructureMap.group.rule.source.listMode",
"short": "first | not_first | last | not_last | only_one",
"definition": "How to handle the list mode for this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapSourceListMode"
}
],
"strength": "required",
"description": "If field is a list, how to manage the source",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-source-list-mode"
}
}
},
{
"id": "StructureMap.group.rule.source.variable",
"path": "StructureMap.group.rule.source.variable",
"short": "Named context for field, if a field is specified",
"definition": "Named context for field, if a field is specified.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.condition",
"path": "StructureMap.group.rule.source.condition",
"short": "FHIRPath expression - must be true or the rule does not apply",
"definition": "FHIRPath expression - must be true or the rule does not apply.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.check",
"path": "StructureMap.group.rule.source.check",
"short": "FHIRPath expression - must be true or the mapping engine throws an error instead of completing",
"definition": "FHIRPath expression - must be true or the mapping engine throws an error instead of completing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target",
"path": "StructureMap.group.rule.target",
"short": "Content to create because of this mapping rule",
"definition": "Content to create because of this mapping rule.",
"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": "smp-2",
"severity": "error",
"human": "Must have a contextType if you have a context",
"expression": "context.exists() implies contextType.exists()",
"xpath": "not(f:context) or (f:contextType)"
},
{
"key": "smp-1",
"severity": "error",
"human": "Can only have a element if you have a context",
"expression": "element.exists() implies context.exists()",
"xpath": "not(f:element) or (f:context)"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.id",
"path": "StructureMap.group.rule.target.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.target.extension",
"path": "StructureMap.group.rule.target.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.target.modifierExtension",
"path": "StructureMap.group.rule.target.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.group.rule.target.context",
"path": "StructureMap.group.rule.target.context",
"short": "Type or variable this rule applies to",
"definition": "Type or variable this rule applies to.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.contextType",
"path": "StructureMap.group.rule.target.contextType",
"short": "type | variable",
"definition": "How to interpret the context.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapContextType"
}
],
"strength": "required",
"description": "How to interpret the context",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-context-type"
}
}
},
{
"id": "StructureMap.group.rule.target.element",
"path": "StructureMap.group.rule.target.element",
"short": "Field to create in the context",
"definition": "Field to create in the context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.variable",
"path": "StructureMap.group.rule.target.variable",
"short": "Named context for field, if desired, and a field is specified",
"definition": "Named context for field, if desired, and a field is specified.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.listMode",
"path": "StructureMap.group.rule.target.listMode",
"short": "first | share | last | collate",
"definition": "If field is a list, how to manage the list.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapTargetListMode"
}
],
"strength": "required",
"description": "If field is a list, how to manage the production",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-target-list-mode"
}
}
},
{
"id": "StructureMap.group.rule.target.listRuleId",
"path": "StructureMap.group.rule.target.listRuleId",
"short": "Internal rule reference for shared list items",
"definition": "Internal rule reference for shared list items.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.transform",
"path": "StructureMap.group.rule.target.transform",
"short": "create | copy +",
"definition": "How the data is copied / created.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapTransform"
}
],
"strength": "required",
"description": "How data is copied/created",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-transform"
}
}
},
{
"id": "StructureMap.group.rule.target.parameter",
"path": "StructureMap.group.rule.target.parameter",
"short": "Parameters to the transform",
"definition": "Parameters to the transform.",
"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"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.parameter.id",
"path": "StructureMap.group.rule.target.parameter.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.target.parameter.extension",
"path": "StructureMap.group.rule.target.parameter.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.target.parameter.modifierExtension",
"path": "StructureMap.group.rule.target.parameter.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.group.rule.target.parameter.value[x]",
"path": "StructureMap.group.rule.target.parameter.value[x]",
"short": "Parameter value - variable or literal",
"definition": "Parameter value - variable or literal.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
},
{
"code": "string"
},
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "decimal"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.rule",
"path": "StructureMap.group.rule.rule",
"short": "Rules contained in this rule",
"definition": "Rules contained in this rule.",
"min": 0,
"max": "*",
"contentReference": "#StructureMap.group.rule",
"isSummary": true
},
{
"id": "StructureMap.group.rule.dependent",
"path": "StructureMap.group.rule.dependent",
"short": "Which other rules to apply in the context of this rule",
"definition": "Which other rules to apply in the context of this rule.",
"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"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.dependent.id",
"path": "StructureMap.group.rule.dependent.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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.dependent.extension",
"path": "StructureMap.group.rule.dependent.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "StructureMap.group.rule.dependent.modifierExtension",
"path": "StructureMap.group.rule.dependent.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "StructureMap.group.rule.dependent.name",
"path": "StructureMap.group.rule.dependent.name",
"short": "Name of a rule or group to apply",
"definition": "Name of a rule or group to apply.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.dependent.variable",
"path": "StructureMap.group.rule.dependent.variable",
"short": "Variable to pass to the rule or group",
"definition": "Variable to pass to the rule or group.",
"min": 1,
"max": "*",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.documentation",
"path": "StructureMap.group.rule.documentation",
"short": "Documentation for this instance of data",
"definition": "Documentation for this instance of data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "StructureMap",
"path": "StructureMap",
"short": "A Map of relationships between 2 structures that can be used to transform data",
"definition": "A Map of relationships between 2 structures that can be used to transform data.",
"alias": [
"Template",
"Profile"
],
"min": 1,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.content"
}
]
},
{
"id": "StructureMap.url",
"path": "StructureMap.url",
"short": "Logical URI to reference this structure map (globally unique)",
"definition": "An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure map is (or will be) published. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).",
"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.",
"requirements": "Allows the structure map 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": "w5",
"map": "id"
}
]
},
{
"id": "StructureMap.identifier",
"path": "StructureMap.identifier",
"short": "Additional identifier for the structure map",
"definition": "A formal identifier that is used to identify this structure map 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, e.g., to identify this structure map 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": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "StructureMap.version",
"path": "StructureMap.version",
"short": "Business version of the structure map",
"definition": "The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map 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 map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the structure map with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "StructureMap.name",
"path": "StructureMap.name",
"short": "Name for this structure map (computer friendly)",
"definition": "A natural language name identifying the structure map. 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 alpha-numeric type name to ensure that it is computable friendly.",
"requirements": "Support human navigation and code generation.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.title",
"path": "StructureMap.title",
"short": "Name for this structure map (human friendly)",
"definition": "A short, descriptive, user-friendly title for the structure map.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.status",
"path": "StructureMap.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this structure map. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of structure maps that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired structure map without due consideration.",
"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 a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "StructureMap.experimental",
"path": "StructureMap.experimental",
"short": "For testing purposes, not real usage",
"definition": "A boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comment": "Allows filtering of structure map that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental structure map in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure map.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "StructureMap.date",
"path": "StructureMap.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the structure map was published. The date must change if and 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 map 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 map. 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": "w5",
"map": "when.recorded"
}
]
},
{
"id": "StructureMap.publisher",
"path": "StructureMap.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the structure map.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the structure map is the organization or individual primarily responsible for the maintenance and upkeep of the structure map. 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 map. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the structure map. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "StructureMap.contact",
"path": "StructureMap.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
},
{
"id": "StructureMap.description",
"path": "StructureMap.description",
"short": "Natural language description of the structure map",
"definition": "A free text natural language description of the structure map from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the structure map 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 map 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"
}
]
},
{
"id": "StructureMap.useContext",
"path": "StructureMap.useContext",
"short": "Context 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 map instances.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "StructureMap.jurisdiction",
"path": "StructureMap.jurisdiction",
"short": "Intended jurisdiction for structure map (if applicable)",
"definition": "A legal or geographic region in which the structure map is intended to be used.",
"comment": "It may be possible for the structure map 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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "StructureMap.purpose",
"path": "StructureMap.purpose",
"short": "Why this structure map is defined",
"definition": "Explaination of why this structure map is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the structure map 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 map.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "StructureMap.copyright",
"path": "StructureMap.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the structure map and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "StructureMap.structure",
"path": "StructureMap.structure",
"short": "Structure Definition used by this map",
"definition": "A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.",
"comment": "It is not necessary for a structure map to identify any dependent structures, though not losting them may restrict its usefulness.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "StructureMap.structure.url",
"path": "StructureMap.structure.url",
"short": "Canonical URL for structure definition",
"definition": "The canonical URL that identifies the structure.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "StructureMap.structure.mode",
"path": "StructureMap.structure.mode",
"short": "source | queried | target | produced",
"definition": "How the referenced structure is used in this mapping.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapModelMode"
}
],
"strength": "required",
"description": "How the referenced structure is used in this mapping",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-model-mode"
}
}
},
{
"id": "StructureMap.structure.alias",
"path": "StructureMap.structure.alias",
"short": "Name for type in this map",
"definition": "The name used for this type in the map.",
"comment": "This is needed if both types have the same name (e.g. version conversion).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.structure.documentation",
"path": "StructureMap.structure.documentation",
"short": "Documentation on use of structure",
"definition": "Documentation that describes how the structure is used in the mapping.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "StructureMap.import",
"path": "StructureMap.import",
"short": "Other maps used by this map (canonical URLs)",
"definition": "Other maps used by this map (canonical URLs).",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "StructureMap.group",
"path": "StructureMap.group",
"short": "Named sections for reader convenience",
"definition": "Organizes the mapping into managable chunks for human review/ease of maintenance.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.name",
"path": "StructureMap.group.name",
"short": "Human-readable label",
"definition": "A unique name for the group for the convenience of human readers.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.extends",
"path": "StructureMap.group.extends",
"short": "Another group that this group adds rules to",
"definition": "Another group that this group adds rules to.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.typeMode",
"path": "StructureMap.group.typeMode",
"short": "none | types | type-and-types",
"definition": "If this is the default rule set to apply for thie source type, or this combination of types.",
"comment": "Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapGroupTypeMode"
}
],
"strength": "required",
"description": "If this is the default rule set to apply for the source type, or this combination of types",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-group-type-mode"
}
}
},
{
"id": "StructureMap.group.documentation",
"path": "StructureMap.group.documentation",
"short": "Additional description/explaination for group",
"definition": "Additional supporting documentation that explains the purpose of the group and the types of mappings within it.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.input",
"path": "StructureMap.group.input",
"short": "Named instance provided when invoking the map",
"definition": "A name assigned to an instance of data. The instance must be provided when the mapping is invoked.",
"comment": "If no inputs are named, then the entry mappings are type based.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.input.name",
"path": "StructureMap.group.input.name",
"short": "Name for this instance of data",
"definition": "Name for this instance of data.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.input.type",
"path": "StructureMap.group.input.type",
"short": "Type for this instance of data",
"definition": "Type for this instance of data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.input.mode",
"path": "StructureMap.group.input.mode",
"short": "source | target",
"definition": "Mode for this instance of data.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapInputMode"
}
],
"strength": "required",
"description": "Mode for this instance of data",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-input-mode"
}
}
},
{
"id": "StructureMap.group.input.documentation",
"path": "StructureMap.group.input.documentation",
"short": "Documentation for this instance of data",
"definition": "Documentation for this instance of data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "StructureMap.group.rule",
"path": "StructureMap.group.rule",
"short": "Transform Rule from source to target",
"definition": "Transform Rule from source to target.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.name",
"path": "StructureMap.group.rule.name",
"short": "Name of the rule for internal references",
"definition": "Name of the rule for internal references.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source",
"path": "StructureMap.group.rule.source",
"short": "Source inputs to the mapping",
"definition": "Source inputs to the mapping.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.context",
"path": "StructureMap.group.rule.source.context",
"short": "Type or variable this rule applies to",
"definition": "Type or variable this rule applies to.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.min",
"path": "StructureMap.group.rule.source.min",
"short": "Specified minimum cardinality",
"definition": "Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.max",
"path": "StructureMap.group.rule.source.max",
"short": "Specified maximum cardinality (number or *)",
"definition": "Specified maximum cardinality for the element - a number or a \"*\". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.type",
"path": "StructureMap.group.rule.source.type",
"short": "Rule only applies if source has this type",
"definition": "Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.defaultValue[x]",
"path": "StructureMap.group.rule.source.defaultValue[x]",
"short": "Default value if no value exists",
"definition": "A value to use if there is no existing value in the source object.",
"comment": "If there's a default value on an item that can repeat, it will only be used once.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.element",
"path": "StructureMap.group.rule.source.element",
"short": "Optional field for this source",
"definition": "Optional field for this source.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.listMode",
"path": "StructureMap.group.rule.source.listMode",
"short": "first | not_first | last | not_last | only_one",
"definition": "How to handle the list mode for this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapSourceListMode"
}
],
"strength": "required",
"description": "If field is a list, how to manage the source",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-source-list-mode"
}
}
},
{
"id": "StructureMap.group.rule.source.variable",
"path": "StructureMap.group.rule.source.variable",
"short": "Named context for field, if a field is specified",
"definition": "Named context for field, if a field is specified.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.condition",
"path": "StructureMap.group.rule.source.condition",
"short": "FHIRPath expression - must be true or the rule does not apply",
"definition": "FHIRPath expression - must be true or the rule does not apply.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.source.check",
"path": "StructureMap.group.rule.source.check",
"short": "FHIRPath expression - must be true or the mapping engine throws an error instead of completing",
"definition": "FHIRPath expression - must be true or the mapping engine throws an error instead of completing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target",
"path": "StructureMap.group.rule.target",
"short": "Content to create because of this mapping rule",
"definition": "Content to create because of this mapping rule.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "smp-2",
"severity": "error",
"human": "Must have a contextType if you have a context",
"expression": "context.exists() implies contextType.exists()",
"xpath": "not(f:context) or (f:contextType)"
},
{
"key": "smp-1",
"severity": "error",
"human": "Can only have a element if you have a context",
"expression": "element.exists() implies context.exists()",
"xpath": "not(f:element) or (f:context)"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.context",
"path": "StructureMap.group.rule.target.context",
"short": "Type or variable this rule applies to",
"definition": "Type or variable this rule applies to.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.contextType",
"path": "StructureMap.group.rule.target.contextType",
"short": "type | variable",
"definition": "How to interpret the context.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapContextType"
}
],
"strength": "required",
"description": "How to interpret the context",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-context-type"
}
}
},
{
"id": "StructureMap.group.rule.target.element",
"path": "StructureMap.group.rule.target.element",
"short": "Field to create in the context",
"definition": "Field to create in the context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.variable",
"path": "StructureMap.group.rule.target.variable",
"short": "Named context for field, if desired, and a field is specified",
"definition": "Named context for field, if desired, and a field is specified.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.listMode",
"path": "StructureMap.group.rule.target.listMode",
"short": "first | share | last | collate",
"definition": "If field is a list, how to manage the list.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapTargetListMode"
}
],
"strength": "required",
"description": "If field is a list, how to manage the production",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-target-list-mode"
}
}
},
{
"id": "StructureMap.group.rule.target.listRuleId",
"path": "StructureMap.group.rule.target.listRuleId",
"short": "Internal rule reference for shared list items",
"definition": "Internal rule reference for shared list items.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.transform",
"path": "StructureMap.group.rule.target.transform",
"short": "create | copy +",
"definition": "How the data is copied / created.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "StructureMapTransform"
}
],
"strength": "required",
"description": "How data is copied/created",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-transform"
}
}
},
{
"id": "StructureMap.group.rule.target.parameter",
"path": "StructureMap.group.rule.target.parameter",
"short": "Parameters to the transform",
"definition": "Parameters to the transform.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.target.parameter.value[x]",
"path": "StructureMap.group.rule.target.parameter.value[x]",
"short": "Parameter value - variable or literal",
"definition": "Parameter value - variable or literal.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
},
{
"code": "string"
},
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "decimal"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.rule",
"path": "StructureMap.group.rule.rule",
"short": "Rules contained in this rule",
"definition": "Rules contained in this rule.",
"min": 0,
"max": "*",
"contentReference": "#StructureMap.group.rule",
"isSummary": true
},
{
"id": "StructureMap.group.rule.dependent",
"path": "StructureMap.group.rule.dependent",
"short": "Which other rules to apply in the context of this rule",
"definition": "Which other rules to apply in the context of this rule.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.dependent.name",
"path": "StructureMap.group.rule.dependent.name",
"short": "Name of a rule or group to apply",
"definition": "Name of a rule or group to apply.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.dependent.variable",
"path": "StructureMap.group.rule.dependent.variable",
"short": "Variable to pass to the rule or group",
"definition": "Variable to pass to the rule or group.",
"min": 1,
"max": "*",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "StructureMap.group.rule.documentation",
"path": "StructureMap.group.rule.documentation",
"short": "Documentation for this instance of data",
"definition": "Documentation for this instance of data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}
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 Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change