structure maps

Create Structure Map

post

/organizations/{organizationId}/fhir/3/StructureMap

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	StructureMap	This is a StructureMap resource
url	string		An absolute URI 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. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).
identifier	array(Identifier)		A 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.
version	string		The 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.
name	string		A 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.
title	string		A short, descriptive, user-friendly title for the structure map.
status	string	draft\|active\|retired\|unknown	The status of this structure map. Enables tracking the life-cycle of the content.
experimental	boolean		A 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.
date	string		The date (and optionally time) when the structure map was published. The date must change if and 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.
publisher	string		The name of the individual or organization that published the structure map.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
description	string		A free text natural language description of the structure map from a consumer's perspective.
useContext	array(UsageContext)		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 for appropriate structure map instances.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the structure map is intended to be used.
purpose	string		Explaination of why this structure map is needed and why it has been designed as it has.
copyright	string		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 structure map.
structure	array(StructureMap_Structure)		A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
import	array()		Other maps used by this map (canonical URLs).
group*	array(StructureMap_Group)		Organizes the mapping into managable chunks for human review/ease of maintenance.

Response

201 400 401 404

Patch Structure Map

patch

/organizations/{organizationId}/fhir/3/StructureMap/{resourceId}

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

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	StructureMap	This is a StructureMap resource
url	string		An absolute URI 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. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).
identifier	array(Identifier)		A 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.
version	string		The 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.
name	string		A 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.
title	string		A short, descriptive, user-friendly title for the structure map.
status	string	draft\|active\|retired\|unknown	The status of this structure map. Enables tracking the life-cycle of the content.
experimental	boolean		A 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.
date	string		The date (and optionally time) when the structure map was published. The date must change if and 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.
publisher	string		The name of the individual or organization that published the structure map.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
description	string		A free text natural language description of the structure map from a consumer's perspective.
useContext	array(UsageContext)		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 for appropriate structure map instances.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the structure map is intended to be used.
purpose	string		Explaination of why this structure map is needed and why it has been designed as it has.
copyright	string		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 structure map.
structure	array(StructureMap_Structure)		A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
import	array()		Other maps used by this map (canonical URLs).
group*	array(StructureMap_Group)		Organizes the mapping into managable chunks for human review/ease of maintenance.

Response

200 201 400 401 404 409

Read Structure Map

get

/organizations/{organizationId}/fhir/3/StructureMap/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Structure Map

get

/organizations/{organizationId}/fhir/3/StructureMap/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Structure Map

get

/organizations/{organizationId}/fhir/3/StructureMap/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Structure Map

delete

/organizations/{organizationId}/fhir/3/StructureMap/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Structure Map

get

/organizations/{organizationId}/fhir/3/StructureMap

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
date	string
description	string
identifier	string
jurisdiction	string
name	string
publisher	string
status	string
title	string
url	string
version	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Structure Map

get

/organizations/{organizationId}/fhir/3/StructureMap/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Structure Map

post

/organizations/{organizationId}/fhir/3/StructureMap/_search

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

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
date	string
description	string
identifier	string
jurisdiction	string
name	string
publisher	string
status	string
title	string
url	string
version	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	StructureMap	This is a StructureMap resource
url	string		An absolute URI 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. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).
identifier	array(Identifier)		A 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.
version	string		The 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.
name	string		A 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.
title	string		A short, descriptive, user-friendly title for the structure map.
status	string	draft\|active\|retired\|unknown	The status of this structure map. Enables tracking the life-cycle of the content.
experimental	boolean		A 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.
date	string		The date (and optionally time) when the structure map was published. The date must change if and 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.
publisher	string		The name of the individual or organization that published the structure map.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
description	string		A free text natural language description of the structure map from a consumer's perspective.
useContext	array(UsageContext)		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 for appropriate structure map instances.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the structure map is intended to be used.
purpose	string		Explaination of why this structure map is needed and why it has been designed as it has.
copyright	string		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 structure map.
structure	array(StructureMap_Structure)		A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
import	array()		Other maps used by this map (canonical URLs).
group*	array(StructureMap_Group)		Organizes the mapping into managable chunks for human review/ease of maintenance.

Response

200 401 404

Update Structure Map

put

/organizations/{organizationId}/fhir/3/StructureMap/{resourceId}

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	StructureMap	This is a StructureMap resource
url	string		An absolute URI 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. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).
identifier	array(Identifier)		A 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.
version	string		The 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.
name	string		A 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.
title	string		A short, descriptive, user-friendly title for the structure map.
status	string	draft\|active\|retired\|unknown	The status of this structure map. Enables tracking the life-cycle of the content.
experimental	boolean		A 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.
date	string		The date (and optionally time) when the structure map was published. The date must change if and 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.
publisher	string		The name of the individual or organization that published the structure map.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
description	string		A free text natural language description of the structure map from a consumer's perspective.
useContext	array(UsageContext)		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 for appropriate structure map instances.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the structure map is intended to be used.
purpose	string		Explaination of why this structure map is needed and why it has been designed as it has.
copyright	string		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 structure map.
structure	array(StructureMap_Structure)		A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
import	array()		Other maps used by this map (canonical URLs).
group*	array(StructureMap_Group)		Organizes the mapping into managable chunks for human review/ease of maintenance.

Response

200 201 400 401 404 409