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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringStructureMapThis is a StructureMap resource
urlstringAn 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).
identifierarray(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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the structure map.
statusstringdraft|active|retired|unknownThe status of this structure map. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the structure map.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the structure map from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the structure map is intended to be used.
purposestringExplaination of why this structure map is needed and why it has been designed as it has.
copyrightstringA 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.
structurearray(StructureMap_Structure)A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
importarray()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

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringStructureMapThis is a StructureMap resource
urlstringAn 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).
identifierarray(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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the structure map.
statusstringdraft|active|retired|unknownThe status of this structure map. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the structure map.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the structure map from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the structure map is intended to be used.
purposestringExplaination of why this structure map is needed and why it has been designed as it has.
copyrightstringA 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.
structurearray(StructureMap_Structure)A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
importarray()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

Read Structure Map

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Structure Map

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Structure Map

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Structure Map

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Structure Map

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
descriptionstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Structure Map

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
descriptionstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringStructureMapThis is a StructureMap resource
urlstringAn 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).
identifierarray(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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the structure map.
statusstringdraft|active|retired|unknownThe status of this structure map. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the structure map.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the structure map from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the structure map is intended to be used.
purposestringExplaination of why this structure map is needed and why it has been designed as it has.
copyrightstringA 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.
structurearray(StructureMap_Structure)A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
importarray()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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringStructureMapThis is a StructureMap resource
urlstringAn 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).
identifierarray(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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the structure map.
statusstringdraft|active|retired|unknownThe status of this structure map. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the structure map.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the structure map from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the structure map is intended to be used.
purposestringExplaination of why this structure map is needed and why it has been designed as it has.
copyrightstringA 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.
structurearray(StructureMap_Structure)A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
importarray()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