structure definitions

Create Structure Definition

post
/organizations/{organizationId}/fhir/3/StructureDefinition

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringStructureDefinitionThis is a StructureDefinition resource
urlstringAn absolute URI that is used to identify this structure definition 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 definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this structure definition 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 definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition 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 definition. 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 definition.
statusstringdraft|active|retired|unknownThe status of this structure definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this structure definition 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 definition 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 definition changes.
publisherstringThe name of the individual or organization that published the structure definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the structure definition 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 definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the structure definition is intended to be used.
purposestringExplaination of why this structure definition is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.
keywordarray(Coding)A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
fhirVersionstringThe version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
mappingarray(StructureDefinition_Mapping)An external specification that the content is mapped to.
kindstringprimitive-type|complex-type|resource|logicalDefines the kind of structure that this definition is describing.
abstractbooleanWhether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
contextTypestringresource|datatype|extensionIf this is an extension, Identifies the context within FHIR resources where the extension can be used.
contextarray()Identifies the types of resource or data type elements to which the extension can be applied.
contextInvariantarray()A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
typestringThe type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).
baseDefinitionstringAn absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
derivationstringspecialization|constraintHow the type relates to the baseDefinition.
snapshotStructureDefinition_SnapshotA snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
differentialStructureDefinition_DifferentialA differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

Response

Patch Structure Definition

patch
/organizations/{organizationId}/fhir/3/StructureDefinition/{resourceId}

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

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*stringStructureDefinitionThis is a StructureDefinition resource
urlstringAn absolute URI that is used to identify this structure definition 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 definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this structure definition 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 definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition 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 definition. 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 definition.
statusstringdraft|active|retired|unknownThe status of this structure definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this structure definition 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 definition 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 definition changes.
publisherstringThe name of the individual or organization that published the structure definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the structure definition 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 definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the structure definition is intended to be used.
purposestringExplaination of why this structure definition is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.
keywordarray(Coding)A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
fhirVersionstringThe version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
mappingarray(StructureDefinition_Mapping)An external specification that the content is mapped to.
kindstringprimitive-type|complex-type|resource|logicalDefines the kind of structure that this definition is describing.
abstractbooleanWhether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
contextTypestringresource|datatype|extensionIf this is an extension, Identifies the context within FHIR resources where the extension can be used.
contextarray()Identifies the types of resource or data type elements to which the extension can be applied.
contextInvariantarray()A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
typestringThe type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).
baseDefinitionstringAn absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
derivationstringspecialization|constraintHow the type relates to the baseDefinition.
snapshotStructureDefinition_SnapshotA snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
differentialStructureDefinition_DifferentialA differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

Response

Read Structure Definition

get
/organizations/{organizationId}/fhir/3/StructureDefinition/{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 Definition

get
/organizations/{organizationId}/fhir/3/StructureDefinition/{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 Definition

get
/organizations/{organizationId}/fhir/3/StructureDefinition/{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 Definition

delete
/organizations/{organizationId}/fhir/3/StructureDefinition/{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 Definition

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

Request

Headers

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

Query params

_idstring
_languagestring
abstractstring
basestring
base-pathstring
context-typestring
datestring
derivationstring
descriptionstring
experimentalstring
ext-contextstring
identifierstring
jurisdictionstring
keywordstring
kindstring
namestring
pathstring
publisherstring
statusstring
titlestring
typestring
urlstring
valuesetstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Structure Definition

get
/organizations/{organizationId}/fhir/3/StructureDefinition/_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 Definition

post
/organizations/{organizationId}/fhir/3/StructureDefinition/_search

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
abstractstring
basestring
base-pathstring
context-typestring
datestring
derivationstring
descriptionstring
experimentalstring
ext-contextstring
identifierstring
jurisdictionstring
keywordstring
kindstring
namestring
pathstring
publisherstring
statusstring
titlestring
typestring
urlstring
valuesetstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringStructureDefinitionThis is a StructureDefinition resource
urlstringAn absolute URI that is used to identify this structure definition 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 definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this structure definition 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 definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition 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 definition. 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 definition.
statusstringdraft|active|retired|unknownThe status of this structure definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this structure definition 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 definition 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 definition changes.
publisherstringThe name of the individual or organization that published the structure definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the structure definition 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 definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the structure definition is intended to be used.
purposestringExplaination of why this structure definition is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.
keywordarray(Coding)A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
fhirVersionstringThe version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
mappingarray(StructureDefinition_Mapping)An external specification that the content is mapped to.
kindstringprimitive-type|complex-type|resource|logicalDefines the kind of structure that this definition is describing.
abstractbooleanWhether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
contextTypestringresource|datatype|extensionIf this is an extension, Identifies the context within FHIR resources where the extension can be used.
contextarray()Identifies the types of resource or data type elements to which the extension can be applied.
contextInvariantarray()A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
typestringThe type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).
baseDefinitionstringAn absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
derivationstringspecialization|constraintHow the type relates to the baseDefinition.
snapshotStructureDefinition_SnapshotA snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
differentialStructureDefinition_DifferentialA differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

Response

Update Structure Definition

put
/organizations/{organizationId}/fhir/3/StructureDefinition/{resourceId}

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringStructureDefinitionThis is a StructureDefinition resource
urlstringAn absolute URI that is used to identify this structure definition 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 definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this structure definition 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 definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition 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 definition. 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 definition.
statusstringdraft|active|retired|unknownThe status of this structure definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this structure definition 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 definition 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 definition changes.
publisherstringThe name of the individual or organization that published the structure definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the structure definition 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 definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the structure definition is intended to be used.
purposestringExplaination of why this structure definition is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.
keywordarray(Coding)A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
fhirVersionstringThe version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
mappingarray(StructureDefinition_Mapping)An external specification that the content is mapped to.
kindstringprimitive-type|complex-type|resource|logicalDefines the kind of structure that this definition is describing.
abstractbooleanWhether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
contextTypestringresource|datatype|extensionIf this is an extension, Identifies the context within FHIR resources where the extension can be used.
contextarray()Identifies the types of resource or data type elements to which the extension can be applied.
contextInvariantarray()A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
typestringThe type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).
baseDefinitionstringAn absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
derivationstringspecialization|constraintHow the type relates to the baseDefinition.
snapshotStructureDefinition_SnapshotA snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
differentialStructureDefinition_DifferentialA differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

Response