> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# StructureMap

> A Map of relationships between 2 structures that can be used to transform data.

## Properties

| Name | Required | Type | Description |
| - | - | - | - |
| url | Yes | uri | Canonical identifier for this structure map, represented as a URI (globally unique) |
| identifier | No | [Identifier](/medical-api/fhir/data-types/identifier)\[] | Additional identifier for the structure map |
| version | No | string | Business version of the structure map |
| name | Yes | string | Name for this structure map (computer friendly) |
| title | No | string | Name for this structure map (human friendly) |
| status | Yes | code | draft / active / retired / unknown |
| experimental | No | boolean | For testing purposes, not real usage |
| date | No | dateTime | Date last changed |
| publisher | No | string | Name of the publisher (organization or individual) |
| contact | No | [ContactDetail](/medical-api/fhir/data-types/contactdetail)\[] | Contact details for the publisher |
| description | No | markdown | Natural language description of the structure map |
| useContext | No | [UsageContext](/medical-api/fhir/data-types/usagecontext)\[] | The context that the content is intended to support |
| jurisdiction | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | Intended jurisdiction for structure map (if applicable) |
| purpose | No | markdown | Why this structure map is defined |
| copyright | No | markdown | Use and/or publishing restrictions |
| structure | No | StructureMapStructure | Structure Definition used by this map |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - url | Yes | canonical | Canonical reference to structure definition |
| - mode | Yes | code | source / queried / target / produced |
| - alias | No | string | Name for type in this map |
| - documentation | No | string | Documentation on use of structure |
| import | No | canonical\[] | Other maps used by this map (canonical URLs) |
| group | Yes | StructureMapGroup | Named sections for reader convenience |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - name | Yes | id | Human-readable label |
| - extends | No | id | Another group that this group adds rules to |
| - typeMode | Yes | code | none / types / type-and-types |
| - documentation | No | string | Additional description/explanation for group |
| - input | Yes | StructureMapGroupInput | Named instance provided when invoking the map |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - name | Yes | id | Name for this instance of data |
| - type | No | string | Type for this instance of data |
| - mode | Yes | code | source / target |
| - documentation | No | string | Documentation for this instance of data |
| - rule | Yes | StructureMapGroupRule | Transform Rule from source to target |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - name | Yes | id | Name of the rule for internal references |
| - source | Yes | StructureMapGroupRuleSource | Source inputs to the mapping |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - context | Yes | id | Type or variable this rule applies to |
| - min | No | integer | Specified minimum cardinality |
| - max | No | string | Specified maximum cardinality (number or \*) |
| - type | No | string | Rule only applies if source has this type |
| - defaultValue\[x] | No | base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, [Address](/medical-api/fhir/data-types/address), [Age](/medical-api/fhir/data-types/age), [Annotation](/medical-api/fhir/data-types/annotation), [Attachment](/medical-api/fhir/data-types/attachment), [CodeableConcept](/medical-api/fhir/data-types/codeableconcept), [Coding](/medical-api/fhir/data-types/coding), [ContactPoint](/medical-api/fhir/data-types/contactpoint), [Count](/medical-api/fhir/data-types/count), [Distance](/medical-api/fhir/data-types/distance), [Duration](/medical-api/fhir/data-types/duration), [HumanName](/medical-api/fhir/data-types/humanname), [Identifier](/medical-api/fhir/data-types/identifier), [Money](/medical-api/fhir/data-types/money), [Period](/medical-api/fhir/data-types/period), [Quantity](/medical-api/fhir/data-types/quantity), [Range](/medical-api/fhir/data-types/range), [Ratio](/medical-api/fhir/data-types/ratio), Reference\<>, [SampledData](/medical-api/fhir/data-types/sampleddata), [Signature](/medical-api/fhir/data-types/signature), [Timing](/medical-api/fhir/data-types/timing), [ContactDetail](/medical-api/fhir/data-types/contactdetail), [Contributor](/medical-api/fhir/data-types/contributor), [DataRequirement](/medical-api/fhir/data-types/datarequirement), [Expression](/medical-api/fhir/data-types/expression), [ParameterDefinition](/medical-api/fhir/data-types/parameterdefinition), [RelatedArtifact](/medical-api/fhir/data-types/relatedartifact), [TriggerDefinition](/medical-api/fhir/data-types/triggerdefinition), [UsageContext](/medical-api/fhir/data-types/usagecontext), [Dosage](/medical-api/fhir/data-types/dosage), [Meta](/medical-api/fhir/data-types/meta) | Default value if no value exists |
| - element | No | string | Optional field for this source |
| - listMode | No | code | first / not\_first / last / not\_last / only\_one |
| - variable | No | id | Named context for field, if a field is specified |
| - condition | No | string | FHIRPath expression - must be true or the rule does not apply |
| - check | No | string | FHIRPath expression - must be true or the mapping engine throws an error instead of completing |
| - logMessage | No | string | Message to put in log if source exists (FHIRPath) |
| - target | No | StructureMapGroupRuleTarget | Content to create because of this mapping rule |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - context | No | id | Type or variable this rule applies to |
| - contextType | No | code | type / variable |
| - element | No | string | Field to create in the context |
| - variable | No | id | Named context for field, if desired, and a field is specified |
| - listMode | No | code\[] | first / share / last / collate |
| - listRuleId | No | id | Internal rule reference for shared list items |
| - transform | No | code | create / copy + |
| - parameter | No | StructureMapGroupRuleTargetParameter | Parameters to the transform |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - value\[x] | Yes | id, string, boolean, integer, decimal | Parameter value - variable or literal |
| - rule | No | \[] | Rules contained in this rule |
| - dependent | No | StructureMapGroupRuleDependent | Which other rules to apply in the context of this rule |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - name | Yes | id | Name of a rule or group to apply |
| - variable | Yes | string\[] | Variable to pass to the rule or group |
| - documentation | No | string | Documentation for this instance of data |

## Search Parameters

| Name | Type | Description | Expression |
| - | - | - | - |
| context | token | A use context assigned to the structure map | StructureMap.useContext.value |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the structure map | StructureMap.useContext.value |
| context-type | token | A type of use context assigned to the structure map | StructureMap.useContext.code |
| date | date | The structure map publication date | StructureMap.date |
| description | string | The description of the structure map | StructureMap.description |
| jurisdiction | token | Intended jurisdiction for the structure map | StructureMap.jurisdiction |
| name | string | Computationally friendly name of the structure map | StructureMap.name |
| publisher | string | Name of the publisher of the structure map | StructureMap.publisher |
| status | token | The current status of the structure map | StructureMap.status |
| title | string | The human-friendly name of the structure map | StructureMap.title |
| url | uri | The uri that identifies the structure map | StructureMap.url |
| version | token | The business version of the structure map | StructureMap.version |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the structure map | StructureMap.useContext |
| context-type-value | composite | A use context type and value assigned to the structure map | StructureMap.useContext |
| identifier | token | External identifier for the structure map | StructureMap.identifier |

## Inherited Properties

| Name | Required | Type | Description |
| - | - | - | - |
| id | No | string | Logical id of this artifact |
| meta | No | [Meta](/medical-api/fhir/data-types/meta) | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | [Narrative](/medical-api/fhir/data-types/narrative) | Text summary of the resource, for human interpretation |
| contained | No | Resource\[] | Contained, inline Resources |
| extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored |

To view the FHIR specification for this resource, see [StructureMap](https://www.hl7.org/fhir/StructureDefinition/StructureMap).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.