StructureMap | Medplum

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

Elements

Name Required Type Description
url ✓ uri Canonical identifier for this structure map, represented as a URI (globally unique)\nDetails\nAn absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.\nCan 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.\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. \nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
identifier Identifier[] Additional identifier for the structure map\nDetails\nA 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.\nTypically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure map outside of FHIR, where it is not possible to use the logical URI.
version string Business version of the structure map\nDetails\nThe 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.\nThere 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 reference to a particular business version of the structure map with the format [url]
name ✓ string Name for this structure map (computer friendly)\nDetails\nA 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.\nThe name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
title string Name for this structure map (human friendly)\nDetails\nA short, descriptive, user-friendly title for the structure map.\nThis name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
status ✓ code draft | active | retired | unknown\nDetails\nThe status of this structure map. Enables tracking the life-cycle of the content.\nAllows filtering of structure maps that are appropriate for use versus not.
experimental boolean For testing purposes, not real usage\nDetails\nA 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.\nAllows filtering of structure maps that are appropriate for use versus not.
date dateTime Date last changed\nDetails\nThe date (and optionally time) when the structure map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.\nNote 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.
publisher string Name of the publisher (organization or individual)\nDetails\nThe name of the organization or individual that published the structure map.\nUsually 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.
contact ContactDetail[] Contact details for the publisher\nDetails\nContact details to assist a user in finding and communicating with the publisher.\nMay be a web site, an email address, a telephone number, etc.
description markdown Natural language description of the structure map\nDetails\nA free text natural language description of the structure map from a consumer's perspective.\nThis 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 structure map is presumed to be the predominant language in the place the structure map was created).
useContext UsageContext[] The context that the content is intended to support\nDetails\nThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances.\nWhen multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdiction CodeableConcept[] Intended jurisdiction for structure map (if applicable)\nDetails\nA legal or geographic region in which the structure map is intended to be used.\nIt may be possible for the structure map to be used in jurisdictions other than those for which it was originally designed or intended.
purpose markdown Why this structure map is defined\nDetails\nExplanation of why this structure map is needed and why it has been designed as it has.\nThis 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.
copyright markdown Use and/or publishing restrictions\nDetails\nA 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.
structure StructureMapStructure[] Structure Definition used by this map\nDetails\nA structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.\nIt is not necessary for a structure map to identify any dependent structures, though not listing them may restrict its usefulness.
id string Unique id for inter-element referencing\nDetails\nUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension Extension[] Additional content defined by implementations\nDetails\nMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.\nThere 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.
modifierExtension Extension[] Extensions that cannot be ignored even if unrecognized\nDetails\nMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).\nThere 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.

Search Parameters

Name Type Description Expression
context token A use context assigned to the structure map StructureMap.useContext.value.ofType(CodeableConcept)
context-quantity quantity A quantity- or range-valued use context assigned to the structure map StructureMap.useContext.value.ofType(Quantity) | StructureMap.useContext.value.ofType(Range)
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 Elements

Name Required Type Description
id string Logical id of this artifact\nDetails\nThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.\nThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta Meta Metadata about the resource\nDetails\nThe 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.
implicitRules uri A set of rules under which this content was created\nDetails\nA 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.\nAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
language code Language of the resource content\nDetails\nThe base language in which the resource is written.\nLanguage 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).
text Narrative Text summary of the resource, for human interpretation\nDetails\nA 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.\nContained 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).
contained Resource[] Contained, inline Resources\nDetails\nThese 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.\nThis 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
extension Extension Additional content defined by implementations\nDetails\nMay 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.\nThere 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.
modifierExtension Extension Extensions that cannot be ignored\nDetails\nMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).\nThere 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.