StructureMap

Trial Use 2 Conformance

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

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/StructureMap

Interaction	Method	Path
Read	GET	/fhir/R4/StructureMap/[id]
Vread	GET	/fhir/R4/StructureMap/[id]/_history/[vid]
Update	PUT	/fhir/R4/StructureMap/[id]
Patch	PATCH	/fhir/R4/StructureMap/[id]
Delete	DELETE	/fhir/R4/StructureMap/[id]
Create	POST	/fhir/R4/StructureMap
Search	GET	/fhir/R4/StructureMap
History	GET	/fhir/R4/StructureMap/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
url	uri	1..1	Canonical identifier for this structure map, represented as a URI (globally unique)
identifier	Identifier	0..*	Additional identifier for the structure map
version	string	0..1	Business version of the structure map
name	string	1..1	Name for this structure map (computer friendly)
title	string	0..1	Name for this structure map (human friendly)
status	code	1..1	draft | active | retired | unknown modifier
experimental	boolean	0..1	For testing purposes, not real usage
date	dateTime	0..1	Date last changed
publisher	string	0..1	Name of the publisher (organization or individual)
contact	ContactDetail	0..*	Contact details for the publisher
description	markdown	0..1	Natural language description of the structure map
useContext	UsageContext	0..*	The context that the content is intended to support
jurisdiction	CodeableConcept	0..*	Intended jurisdiction for structure map (if applicable)
purpose	markdown	0..1	Why this structure map is defined
copyright	markdown	0..1	Use and/or publishing restrictions
structure	BackboneElement	0..*	Structure Definition used by this map
import	canonical	0..*	Other maps used by this map (canonical URLs)
group	BackboneElement	1..*	Named sections for reader convenience

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
context	string	http://hl7.org/fhir/SearchParameter/conformance-context
context-quantity	string	http://hl7.org/fhir/SearchParameter/conformance-context-quantity
context-type	string	http://hl7.org/fhir/SearchParameter/conformance-context-type
context-type-quantity	string	http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity
context-type-value	string	http://hl7.org/fhir/SearchParameter/conformance-context-type-value
date	string	http://hl7.org/fhir/SearchParameter/conformance-date
description	string	http://hl7.org/fhir/SearchParameter/conformance-description
identifier	string	http://hl7.org/fhir/SearchParameter/conformance-identifier
jurisdiction	string	http://hl7.org/fhir/SearchParameter/conformance-jurisdiction
name	string	http://hl7.org/fhir/SearchParameter/conformance-name
publisher	string	http://hl7.org/fhir/SearchParameter/conformance-publisher
status	string	http://hl7.org/fhir/SearchParameter/conformance-status
title	string	http://hl7.org/fhir/SearchParameter/conformance-title
url	string	http://hl7.org/fhir/SearchParameter/conformance-url
version	string	http://hl7.org/fhir/SearchParameter/conformance-version

Reference

• Official FHIR R4 spec: StructureMap
• Maturity: Trial Use 2 (FMM 2).