STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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
StructureDefinition for structuremap
{
"resourceType": "StructureDefinition",
"id": "StructureMap",
"meta": {
"lastUpdated": "2016-03-31T08:01:25.570+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
}
],
"url": "http://hl7.org/fhir/StructureDefinition/StructureMap",
"name": "StructureMap",
"status": "draft",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"date": "2016-03-31T08:01:25+11:00",
"description": "Base StructureDefinition for StructureMap Resource",
"fhirVersion": "1.4.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"kind": "resource",
"abstract": false,
"baseType": "DomainResource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"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",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.content"
}
]
},
{
"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.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"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": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "StructureMap.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"path": "StructureMap.url",
"short": "Absolute URL used to reference this StructureMap",
"definition": "An absolute URL 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.",
"alias": [
"url",
"authoritative-url",
"destination",
"identity"
],
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "StructureMap.identifier",
"short": "Other identifiers for the StructureMap",
"definition": "Formal identifier that is used to identify this StructureMap when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "StructureMap.version",
"short": "Logical id for this version of the StructureMap",
"definition": "The identifier that is used to identify this version of the StructureMap when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureMap author manually.",
"comments": "There may be multiple resource versions of the StructureMap that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"path": "StructureMap.name",
"short": "Informal name for this StructureMap",
"definition": "A free text natural language name identifying the StructureMap.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureMap.status",
"short": "draft | active | retired",
"definition": "The status of the StructureMap.",
"comments": "Allows filtering of StructureMaps that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conformance-resource-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "StructureMap.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This StructureMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of StructureMaps that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "StructureMap.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the structure map.",
"comments": "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"
}
]
},
{
"path": "StructureMap.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "StructureMap.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureMap.contact.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.",
"comments": "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"
}
]
},
{
"path": "StructureMap.contact.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.",
"comments": "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"
}
]
},
{
"path": "StructureMap.contact.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact regarding the structure map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureMap.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "StructureMap.date",
"short": "Date for this version of the StructureMap",
"definition": "The date this version of the structure map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"path": "StructureMap.description",
"short": "Natural language description of the StructureMap",
"definition": "A free text natural language description of the StructureMap and its use.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureMap.useContext",
"short": "Content intends to support these contexts",
"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 of structure maps.",
"comments": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/use-context"
}
}
},
{
"path": "StructureMap.requirements",
"short": "Scope and Usage this structure map is for",
"definition": "Explains why this structure map is needed and why it's been designed as it has.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"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 details of the constraints and mappings.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"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.",
"comments": "It is not necessary for a structure map to identify any dependent structures, though not losting them may restrict it's usefulness.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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
},
{
"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": {
"strength": "required",
"description": "How the referenced structure is used in this mapping",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-model-mode"
}
}
},
{
"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"
}
]
},
{
"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
},
{
"path": "StructureMap.group",
"short": "Named sections for reader convenience",
"definition": "Named sections for reader convenience.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"path": "StructureMap.group.name",
"short": "Descriptive name for a user",
"definition": "Descriptive name for a user.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"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
},
{
"path": "StructureMap.group.documentation",
"short": "Documentation for this group",
"definition": "Documentation for this group.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"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.",
"comments": "If no inputs are named, then the entry mappings are type based.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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
},
{
"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
},
{
"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": {
"strength": "required",
"description": "Mode for this instance of data",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-input-mode"
}
}
},
{
"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": "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
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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
},
{
"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
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"path": "StructureMap.group.rule.source.required",
"short": "Whether this rule applies if the source isn't found",
"definition": "Whether this rule applies if the source isn't found.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"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
},
{
"path": "StructureMap.group.rule.source.contextType",
"short": "type | variable",
"definition": "How to interpret the context.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "How to interpret the context",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-context-type"
}
}
},
{
"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
},
{
"path": "StructureMap.group.rule.source.listMode",
"short": "first | share | last",
"definition": "How to handle the list mode for this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "If field is a list, how to manage the list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-list-mode"
}
}
},
{
"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
},
{
"path": "StructureMap.group.rule.source.condition",
"short": "FluentPath expression - must be true or the rule does not apply",
"definition": "FluentPath expression - must be true or the rule does not apply.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureMap.group.rule.source.check",
"short": "FluentPath expression - must be true or the mapping engine throws an error instead of completing",
"definition": "FluentPath expression - must be true or the mapping engine throws an error instead of completing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"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"
}
],
"isSummary": true
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"path": "StructureMap.group.rule.target.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
},
{
"path": "StructureMap.group.rule.target.contextType",
"short": "type | variable",
"definition": "How to interpret the context.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "How to interpret the context",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-context-type"
}
}
},
{
"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
},
{
"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
},
{
"path": "StructureMap.group.rule.target.listMode",
"short": "first | share | last",
"definition": "If field is a list, how to manage the list.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "If field is a list, how to manage the list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-list-mode"
}
}
},
{
"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
},
{
"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": {
"strength": "required",
"description": "How data is copied / created",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-transform"
}
}
},
{
"path": "StructureMap.group.rule.target.parameter",
"short": "Parameters to the transform",
"definition": "Parameters to the transform.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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
},
{
"path": "StructureMap.group.rule.rule",
"short": "Rules contained in this rule",
"definition": "Rules contained in this rule.",
"min": 0,
"max": "*",
"contentReference": "#rule",
"isSummary": true
},
{
"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
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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.",
"comments": "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"
}
]
},
{
"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
},
{
"path": "StructureMap.group.rule.dependent.variable",
"short": "Names of variables to pass to the rule or group",
"definition": "Names of variables to pass to the rule or group.",
"min": 1,
"max": "*",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"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": [
{
"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",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.content"
}
]
},
{
"path": "StructureMap.url",
"short": "Absolute URL used to reference this StructureMap",
"definition": "An absolute URL 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.",
"alias": [
"url",
"authoritative-url",
"destination",
"identity"
],
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "StructureMap.identifier",
"short": "Other identifiers for the StructureMap",
"definition": "Formal identifier that is used to identify this StructureMap when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "StructureMap.version",
"short": "Logical id for this version of the StructureMap",
"definition": "The identifier that is used to identify this version of the StructureMap when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureMap author manually.",
"comments": "There may be multiple resource versions of the StructureMap that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"path": "StructureMap.name",
"short": "Informal name for this StructureMap",
"definition": "A free text natural language name identifying the StructureMap.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureMap.status",
"short": "draft | active | retired",
"definition": "The status of the StructureMap.",
"comments": "Allows filtering of StructureMaps that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conformance-resource-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "StructureMap.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This StructureMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of StructureMaps that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "StructureMap.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the structure map.",
"comments": "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"
}
]
},
{
"path": "StructureMap.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "StructureMap.contact.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact regarding the structure map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureMap.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "StructureMap.date",
"short": "Date for this version of the StructureMap",
"definition": "The date this version of the structure map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"path": "StructureMap.description",
"short": "Natural language description of the StructureMap",
"definition": "A free text natural language description of the StructureMap and its use.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureMap.useContext",
"short": "Content intends to support these contexts",
"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 of structure maps.",
"comments": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/use-context"
}
}
},
{
"path": "StructureMap.requirements",
"short": "Scope and Usage this structure map is for",
"definition": "Explains why this structure map is needed and why it's been designed as it has.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"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 details of the constraints and mappings.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"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.",
"comments": "It is not necessary for a structure map to identify any dependent structures, though not losting them may restrict it's usefulness.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"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
},
{
"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": {
"strength": "required",
"description": "How the referenced structure is used in this mapping",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-model-mode"
}
}
},
{
"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"
}
]
},
{
"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
},
{
"path": "StructureMap.group",
"short": "Named sections for reader convenience",
"definition": "Named sections for reader convenience.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "StructureMap.group.name",
"short": "Descriptive name for a user",
"definition": "Descriptive name for a user.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"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
},
{
"path": "StructureMap.group.documentation",
"short": "Documentation for this group",
"definition": "Documentation for this group.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"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.",
"comments": "If no inputs are named, then the entry mappings are type based.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"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
},
{
"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
},
{
"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": {
"strength": "required",
"description": "Mode for this instance of data",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-input-mode"
}
}
},
{
"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": "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
},
{
"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
},
{
"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
},
{
"path": "StructureMap.group.rule.source.required",
"short": "Whether this rule applies if the source isn't found",
"definition": "Whether this rule applies if the source isn't found.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"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
},
{
"path": "StructureMap.group.rule.source.contextType",
"short": "type | variable",
"definition": "How to interpret the context.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "How to interpret the context",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-context-type"
}
}
},
{
"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
},
{
"path": "StructureMap.group.rule.source.listMode",
"short": "first | share | last",
"definition": "How to handle the list mode for this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "If field is a list, how to manage the list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-list-mode"
}
}
},
{
"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
},
{
"path": "StructureMap.group.rule.source.condition",
"short": "FluentPath expression - must be true or the rule does not apply",
"definition": "FluentPath expression - must be true or the rule does not apply.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureMap.group.rule.source.check",
"short": "FluentPath expression - must be true or the mapping engine throws an error instead of completing",
"definition": "FluentPath expression - must be true or the mapping engine throws an error instead of completing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"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"
}
],
"isSummary": true
},
{
"path": "StructureMap.group.rule.target.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
},
{
"path": "StructureMap.group.rule.target.contextType",
"short": "type | variable",
"definition": "How to interpret the context.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "How to interpret the context",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-context-type"
}
}
},
{
"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
},
{
"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
},
{
"path": "StructureMap.group.rule.target.listMode",
"short": "first | share | last",
"definition": "If field is a list, how to manage the list.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "If field is a list, how to manage the list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-list-mode"
}
}
},
{
"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
},
{
"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": {
"strength": "required",
"description": "How data is copied / created",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/map-transform"
}
}
},
{
"path": "StructureMap.group.rule.target.parameter",
"short": "Parameters to the transform",
"definition": "Parameters to the transform.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"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
},
{
"path": "StructureMap.group.rule.rule",
"short": "Rules contained in this rule",
"definition": "Rules contained in this rule.",
"min": 0,
"max": "*",
"contentReference": "#rule",
"isSummary": true
},
{
"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
},
{
"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
},
{
"path": "StructureMap.group.rule.dependent.variable",
"short": "Names of variables to pass to the rule or group",
"definition": "Names of variables to pass to the rule or group.",
"min": 1,
"max": "*",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"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 STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:10+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change