Structure Map

$10 / year

The Structure Map resource defines a detailed set of rules that describe how one Structure is related to another and provides sufficient detail to allow for automated conversion of instances.


The intention of the structure map resource is to allow a specialist in formats and interoperability to specify the full relationships between two structures (e.g. a CDA document and a set of FHIR resources), and then many different systems – both testing and production clinical systems – can leverage that to automatically transform from one format to the other.

Maps are unidirectional: they map from the source structure to the target structure, and no reverse map is implied. Even if the mapping is simple, and loss-less, it cannot be assumed that there are no conditions that might additionally apply in the reverse direction.

Each structure map contains, in addition to the standard metadata that all conformance resources contain, the following information:

– A list of the structure definitions referenced by the map
– A list of other structure maps that the map uses
– One or more groups of rules that describe how content in the source is transformed to content in the target
– Each group of rules defines a set of input and output variables that must be passed when the group is invoked in a particular context. When a group is invoked, all the rules in the group are checked to see whether they apply.

Each rule may have some or all of the following properties:

– A name – used as the identity in internal references, and traces
– Contexts in both source and target models that define where the rule applies
– A set of source elements that provide data to be mapped
– Conditions that specify if the rule is to apply
– A set of target elements that will be created
– Transform rules that describe how raw data is converted from the source format to the target format (e.g. string manipulation)
– Flags for how instances that can repeat are handled
– Additional rules that apply to the newly created elements (e.g. new contexts)

The mapping language is entirely declarative; there is no imperative or procedural aspects to the definitions.

Date Created


Last Modified




Update Frequency


Temporal Coverage


Spatial Coverage

United States


John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements


Source Citation



FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Structure Map Resource, Electronic Health Records Exchange Through FHIR

Concept_NameName of the concept in the FHIR structurestringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its usestring-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
EnumThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
RequiredThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
ConstThe value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItemsEnumRequiredConst
StructureMapresourceTypeThis is a StructureMap resourceStructureMap
StructureMapid#/definitions/idThe logical id of the resource as used in the URL for the resource. Once assigned this value never changes.
StructureMapmeta#/definitions/MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
StructureMapimplicitRules#/definitions/uriA reference to a set of rules that were followed when the resource was constructed and which must be understood when processing the content. Often this is a reference to an implementation guide that defines the special rules along with other profiles etc.
StructureMap_implicitRules#/definitions/ElementExtensions for implicitRules
StructureMaplanguage#/definitions/codeThe base language in which the resource is written.
StructureMap_language#/definitions/ElementExtensions for language
StructureMaptext#/definitions/NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
StructureMapcontainedarrayThese 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.{'$ref': '#/definitions/ResourceList'}
StructureMapextensionarrayMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension there is a set of requirements that SHALL be met as part of the definition of the extension.{'$ref': '#/definitions/Extension'}
Related Data Packages