Base Module Resources

System resources that do not belong to any specific module.

Overview

Base module includes the following resource types:

• AidboxJob

• AidboxJobStatus

• AidboxConfig

• AidboxMigration

• AidboxProfile

• AidboxQuery

• SearchQuery

• Concept

• Module

• Operation

• Search

• App

• AidboxArchive

• BatchValidationError

• BatchValidationRun

• PGSequence

• AidboxSubscription

• Attribute

• Entity

• ui_history

• ui_snippet

• Notebook

• Mapping

• ConceptMapRule

• FlatImportStatus

• FtrConfig

• TerminologyBundleFile

• IndexCreationJob

• Lambda

• SeedImport

• SubsNotification

• SubsSubscription

AidboxJob

Path	Card.	Type	Description
every	0..1	integer	Frequency in seconds at which the job should run.
_source	0..1	string	System Property. DO NOT USE IT.
status	0..1	Object	Current status information for the job.
module	0..1	string	Module that this job belongs to.
text	0..1	string	Human-readable description of the job.
action	0..1	Object	Action to be performed when the job runs.
type	0..1	string	Type of job scheduling pattern. Allowed values: periodic | each-day
at	0..1	string	Time of day when the job should run (for each-day type).

AidboxJobStatus

Path	Card.	Type	Description
stop	0..1	dateTime	Time when the job execution stopped.
job	0..1	Reference	Reference to the job definition.
error	0..1	Object	Error information if the job failed.
_source	0..1	string	System Property. DO NOT USE IT.
status	0..1	string	Current status of the job execution.
module	0..1	string	Module that this job status belongs to.
start	0..1	dateTime	Time when the job execution started.
text	0..1	string	Human-readable status information.
nextStart	0..1	dateTime	Scheduled time for the next execution of the job.
locked	0..1	boolean	Indicates whether the job is currently locked to prevent concurrent execution.
result	0..1	Object	Result data from the job execution.

AidboxConfig

Path	Card.	Type	Description
box	0..1		Box configuration parameters.
auth	0..1	BackboneElement	Authentication configuration settings.
auth.keys	0..1	BackboneElement	Cryptographic keys for authentication.
auth.keys.secret	0..1	string	Secret key used for signing.
auth.keys.public	0..1	string	Public key used for verification.
_source	0..1	string	System Property. DO NOT USE IT.

AidboxMigration

Path	Card.	Type	Description
dateTime	0..1	dateTime	Time when the migration was created or executed.
_source	0..1	string	System Property. DO NOT USE IT.
status	0..1	string	Current status of the migration. Allowed values: pending | done | error
module	0..1	string	Module that this migration belongs to.
text	0..1	string	Human-readable description of the migration.
action	0..1	Object	Action to be performed for the migration.
result	0..1	Object	Result data from the migration execution.

AidboxProfile

Path	Card.	Type	Description
bind	1..1	Reference	Reference to the resource to which this profile is bound.
schema	1..1	Object	Schema definition for the profile.
_source	0..1	string	System Property. DO NOT USE IT.

AidboxQuery

Path	Card.	Type	Description
params	0..1	Object	Parameters for the query.
query	1..1	string	SQL query string.
_source	0..1	string	System Property. DO NOT USE IT.
count-query	0..1	string	SQL query to count total results.
enable-links	0..1	boolean	Whether to generate FHIR links for pagination.
type	0..1	string	Type of query operation. Allowed values: query | execute
omit-sql	0..1	boolean	Whether to omit SQL in response metadata.

SearchQuery

Path	Card.	Type	Description
resource	1..1	Reference	Reference to the resource type to search.
total	0..1	boolean	Whether to include total count in results.
as	0..1	string	Alias for the resource in the query.
limit	0..1	integer	Maximum number of results to return.
params	0..1	Object	Search parameters for the query.
includes	0..1	Object	Resources to include with the results.
query	0..1	BackboneElement	Detailed query configuration.
query.order-by	0..1	string	Column or expression to order results by.
query.join	0..1	Object	Join conditions for the query.
query.where	0..1	string	Where clause for the query.
_source	0..1	string	System Property. DO NOT USE IT.

Concept

Path	Card.	Type	Description
designation	0..1	BackboneElement	Additional representations for the concept.
designation.definition	0..1	Object	Additional definitions for the concept.
designation.display	0..1	Object	Display names in different languages or contexts.
ancestors	0..1	Object	List of ancestor concepts in the hierarchy.
valueset	0..*	string	Value sets that include this concept.
hierarchy	0..*	string	Hierarchies this concept belongs to.
_source	0..1	string	System Property. DO NOT USE IT.
deprecated	0..1	boolean	Indicates whether the concept is deprecated.
property	0..1	Object	Additional properties associated with the concept.
definition	0..1	string	Formal definition of the concept.
display	0..1	string	Human-readable representation of the concept.
system	1..1	string	Code system that defines the concept.
code	1..1	string	Symbol or identifier for the concept within the system.

Module

Path	Card.	Type	Description
meta	0..1	Meta	Metadata for the module.
meta.pre-sql	0..1	string	SQL to execute before module installation.
meta.post-sql	0..1	string	SQL to execute after module installation.
module	0..1	string	Identifier for the module.
version	0..1	integer	Version number of the module.
_source	0..1	string	System Property. DO NOT USE IT.

Operation

Path	Card.	Type	Description
fhirCode	0..1	string	FHIR operation code.
transform	0..1	BackboneElement	Transformation configuration for the operation.
transform.request	0..1	BackboneElement	Request transformation settings.
transform.request.engine	0..1	code	Transformation engine to use.
transform.request.template	0..1	Reference	Reference to a template for transformation.
transform.request.part	1..1	string	Part of the request to transform. Allowed values: body
route-params	0..1	Object	Parameters for route matching.
fhirResource	0..*	string	FHIR resources this operation applies to.
no-op-logs	0..1	boolean	Whether to disable operation logging.
_source	0..1	string	System Property. DO NOT USE IT.
implicit-params	0..1	BackboneElement	Parameters that are implicitly included in the operation.
implicit-params.path	0..1	Object	Path parameters.
implicit-params.query	0..1	Object	Query parameters.
module	0..1	string	Module that this operation belongs to.
request	0..*	Object	Request configurations.
fhirUrl	0..1	string	FHIR URL pattern for the operation.
action	0..1	Object	Action to be performed by the operation.
app	0..1	Reference	Reference to associated App. Allowed references: App
public	0..1	boolean	Whether the operation is publicly accessible.
data	0..1	Object	Additional operation data.
description	0..1	string	Human-readable description of the operation.

Search

Path	Card.	Type	Description
resource	0..1	Reference	Reference to the resource type this search applies to.
where	0..1	string	SQL WHERE clause for the search.
name	0..1	string	Name of the search parameter.
_source	0..1	string	System Property. DO NOT USE IT.
param-parser	0..1	string	Parser to use for the search parameter. Allowed values: token | reference
module	0..1	string	Module that this search belongs to.
order-by	0..1	string	Default sort order for search results.
token-sql	0..1	BackboneElement	SQL templates for token parameter handling.
token-sql.text	0..1	string	SQL template for text search.
token-sql.both	0..1	string	SQL template when both system and code are provided.
token-sql.only-system	0..1	string	SQL template when only system is provided.
token-sql.only-code	0..1	string	SQL template when only code is provided.
token-sql.text-format	0..1	string	Format for text search.
token-sql.no-system	0..1	string	SQL template when no system is provided.
multi	0..1	string	How multiple values for this parameter should be handled. Allowed values: array
format	0..1	string	Format of the search parameter.

App

Path	Card.	Type	Description
migrations	0..*	BackboneElement	List of migrations for this app.
migrations.id	0..1	string	Unique identifier for the migration.
migrations.dateTime	0..1	string	Timestamp for the migration.
migrations.action	0..1	string	Action to be performed for the migration.
_source	0..1	string	System Property. DO NOT USE IT.
type	1..1	code	Type of application. Allowed values: app | addon
endpoint	0..1	BackboneElement	Endpoint configuration for the app.
endpoint.secret	0..1	string	Secret key for endpoint authentication.
endpoint.url	0..1	string	URL of the endpoint.
endpoint.type	0..1	code	Type of endpoint protocol. Allowed values: http-rpc | ws-rpc | native
apiVersion	1..1	integer	Version of the API this app uses.
hooks	0..1	Object	Hooks configuration for the app.
subscriptions	0..1	Object	Subscriptions configuration for the app.
entities	0..1	Object	Entities defined by the app.
operations	0..1	Object	Operations defined by the app.

AidboxArchive

Path	Card.	Type	Description
archiveFile	0..1	string	Name of the archive file.
serviceAccount	0..1	BackboneElement	Service account credentials for accessing storage.
serviceAccount.id	0..1	string	Identifier for the service account.
serviceAccount.resourceType	0..1	string	Type of resource that contains service account credentials.
serviceAccount.display	0..1	string	Human-readable name for the service account.
serviceAccount.secret-key	0..1	string	Secret key for service account authentication.
bucket	0..1	string	Storage bucket where archives are stored.
archivedResourcesCount	0..1	number	Count of resources that have been archived.
criteriaPaths	0..*	string	Paths to use for filtering resources to archive.
history	0..1	boolean	Whether to include resource history in the archive.
storageBackend	0..1	string	Type of storage backend to use. Allowed values: gcp | aws | local
period	0..1	BackboneElement	Time period for the resources to archive.
period.start	0..1	dateTime	Start date/time for the archive period.
period.end	0..1	dateTime	End date/time for the archive period.
targetResourceType	0..1	string	Resource type to be archived.

BatchValidationError

Path	Card.	Type	Description
resource	0..1	BackboneElement	Reference to the resource that failed validation.
resource.id	0..1	string	Resource identifier.
resource.resourceType	0..1	string	Type of resource.
resource.display	0..1	string	Human-readable display name for the resource.
run	0..1	BackboneElement	Reference to the validation run that produced this error.
run.id	0..1	string	Validation run identifier.
run.resourceType	0..1	string	Type of the validation run resource.
run.display	0..1	string	Human-readable display name for the validation run.
profiles	0..*	string	Profiles against which the resource was validated.
errors	0..*	Object	List of validation errors found.

BatchValidationRun

Path	Card.	Type	Description
resource	0..1	string	Resource type to validate.
errorsThreshold	0..1	integer	Maximum number of errors before stopping validation.
schemas	0..*	string	List of schemas to validate against.
invalid	0..1	integer	Count of invalid resources found.
async	0..1	boolean	Whether validation is performed asynchronously.
limit	0..1	integer	Maximum number of resources to validate.
profiles	0..*	string	FHIR profiles to validate against.
valid	0..1	integer	Count of valid resources found.
status	0..1	string	Current status of the validation run. Allowed values: in-progress | complete
filter	0..1	string	Expression to filter resources for validation.
duration	0..1	integer	Duration of the validation run in milliseconds.

PGSequence

Path	Card.	Type	Description
data_type	0..1	string	PostgreSQL data type for the sequence. Allowed values: smallint | integer | bigint
cycle	0..1	boolean	Whether the sequence should cycle when reaching max/min value.
increment	0..1	integer	Value to increment by for each sequence call.
_source	0..1	string	System Property. DO NOT USE IT.
start	0..1	integer	Starting value for the sequence.
minvalue	0..1	integer	Minimum value for the sequence.
maxvalue	0..1	integer	Maximum value for the sequence.

AidboxSubscription

Path	Card.	Type	Description
module	0..1	string	Module that this subscription belongs to.
action	0..1	Object	Action to be performed when the subscription is triggered.
type	0..1	string	Type of subscription execution model. Allowed values: sync | async
resources	0..*	string	List of resource types this subscription applies to.
_source	0..1	string	System Property. DO NOT USE IT.

Attribute

Path	Card.	Type	Description
resource	1..1	Reference	Reference to the resource type this attribute belongs to.
isUnique	0..1	boolean	Whether this attribute has unique values.
refers	0..*	string	Resource types this attribute can reference.
isCollection	0..1	boolean	Whether this attribute is a collection.
extensionUrl	0..1	string	URL for the extension this attribute represents.
valueSet	0..1		Value set constraint for this attribute.
valueSet.resourceType	0..1	string	Type of the value set resource.
valueSet.id	0..1	string	Identifier of the value set.
valueSet.uri	0..1	string	URI of the value set.
union	0..*	Reference	References to other attributes in a union type.
path	0..*	string	Path to the attribute within the resource.
schema	0..1	Object	Schema for the attribute.
_source	0..1	string	System Property. DO NOT USE IT.
module	0..1	string	Module that this attribute belongs to.
text	0..1	string	Human-readable text about the attribute.
order	0..1	integer	Order for display or processing.
type	0..1	Reference	Reference to the attribute's data type.
isSummary	0..1	boolean	Whether this attribute is included in summary views.
isOpen	0..1	boolean	Whether this attribute allows additional properties.
description	0..1	string	Human-readable description of the attribute.
isModifier	0..1	boolean	Whether this attribute changes the meaning of the resource.
isRequired	0..1	boolean	Whether this attribute is required.
enum	0..*	string	Enumeration of allowed values for this attribute.

Entity

Path	Card.	Type	Description
sequencePrefix	0..1	string	Prefix for sequence-generated IDs.
schema	0..1	Object	Schema definition for the entity.
_source	0..1	string	System Property. DO NOT USE IT.
nonPersistable	0..1	boolean	Whether this entity should not be persisted.
module	0..1	string	Module that this entity belongs to.
text	0..1	string	Human-readable text about the entity.
isMeta	0..1	boolean	Whether this entity is a metadata entity.
history	0..1	string	History tracking mode for this entity. Allowed values: none | diff
type	1..1	string	Type of entity definition. Allowed values: abstract | resource | type | primitive
isOpen	0..1	boolean	Whether this entity allows additional properties.
idGeneration	0..1	string	Strategy for generating IDs for this entity. Allowed values: sequence | uuid
description	0..1	string	Human-readable description of the entity.

ui_history

Path	Card.	Type	Description
user	0..1	Reference	Reference to the user who performed the action. Allowed references: User
type	0..1	string	Type of history entry. Allowed values: http | sql
command	0..1	string	Command that was executed.
_source	0..1	string	System Property. DO NOT USE IT.

ui_snippet

Path	Card.	Type	Description
title	0..1	string
command	0..1	string
user	0..1	Reference	Allowed references: User
type	0..1	string	Allowed values: http | sql
_source	0..1	string	System Property. DO NOT USE IT.

Notebook

Path	Card.	Type	Description
origin	0..1	string	Origin information for the notebook.
tags	0..*	string	Tags associated with the notebook.
notebook-superuser-secret	0..1	string	Secret for superuser access to the notebook.
name	0..1	string	Name of the notebook.
edit-secret	0..1	string	Secret for edit access to the notebook.
publication-id	0..1	string	Identifier for the published version of the notebook.
source	0..1		Source content for the notebook.
cells	0..*		Cells contained in the notebook.
cells.id	0..1		Unique identifier for the cell.
cells.evaluating?	0..1	boolean	Whether the cell is currently being evaluated.
cells.folded	0..1		Folding state of the cell.
cells.folded.code	0..1	boolean	Whether the code section is folded.
cells.folded.result	0..1	boolean	Whether the result section is folded.
cells.type	0..1	string	Type of cell content. Allowed values: rpc | rest | empty | markdown | sql
cells.value	0..1		Content value of the cell.
cells.result	0..1		Result of cell evaluation.
cells.error	0..1		Error information if evaluation failed.
cells.nb-title	0..1	string	Title for the cell.
description	0..1	string	Description of the notebook.

Mapping

Path	Card.	Type	Description
returns	0..1	code	Type of result returned by the mapping. Allowed values: transaction | resource
body	1..1	Object	Mapping transformation definition.
params	0..1		Parameters for the mapping execution.
params.omit-drop-blanks	0..1	boolean	Whether to omit blank values from the result.
scopeSchema	0..1	Object	Schema defining the scope for mapping.
_source	0..1	string	System Property. DO NOT USE IT.
text	0..1		Human-readable text about the mapping.
text.status	0..1	string	Status of the text.
text.div	0..1	string	HTML representation of the text.

ConceptMapRule

Path	Card.	Type	Description
unmapped	0..1	Object	Rules for handling unmapped concepts.
unmapped.url	0..1	string	URL for unmapped value set.
unmapped.mode	0..1	string	Mode for handling unmapped concepts.
sourceValueSet	0..1	string	Source value set for the mapping.
element	0..1	Object	Element mapping definition.
element.target	0..1		Target mapping information.
element.target.comment	0..1	string	Comment about the mapping.
element.target.equivalence	0..1	string	Equivalence relationship between source and target.
_source	0..1	string	System Property. DO NOT USE IT.
source	0..1	string	Source system for the mapping.
target	0..1	string	Target system for the mapping.
conceptmapUrl	0..1	string	URL of the parent concept map.
targetValueSet	0..1	string	Target value set for the mapping.
conceptmapId	0..1	string	ID of the parent concept map.

FlatImportStatus

Path	Card.	Type	Description
status	0..1	string	Current status of the import process. Allowed values: in-progress | done | fail
params	0..1	Object	Parameters used for the import.
result	0..1		Result information for successful import.
result.count	0..1	integer	Count of successfully imported resources.
error	0..1		Error information when import fails.
error.code	0..1	string	Error code.
error.message	0..1	string	Error message description.

FtrConfig

Path	Card.	Type	Description
package-name	0..1	string	Name of the FHIR terminology package.
module	0..1	string	Module that this configuration belongs to.
tag	0..1	string	Tag for terminology resources.
tag-index	0..1		Index of tags and their associations.

TerminologyBundleFile

Path	Card.	Type	Description
filename	0..1	string	Name of the terminology bundle file.
status	0..1	string	Current status of the bundle file processing. Allowed values: pending | in-progress | fail | success

IndexCreationJob

Path	Card.	Type	Description
procstatus	0..1	string	Current status of the index creation process. Allowed values: pending | in-progress | done | error
message	0..1	string	Status or error message.
resource	0..1	string	Resource type for which the index is being created.
index	0..1	string	Name of the database index being created.
params	0..*	string	Parameters for the index creation.
start	0..1	dateTime	Time when the index creation started.
end	0..1	dateTime	Time when the index creation finished.

Lambda

Path	Card.	Type	Description
hook	1..1	code	Type of hook this lambda responds to. Allowed values: audit
code	1..1	string	Code to be executed by the lambda.
_source	0..1	string	System Property. DO NOT USE IT.

SeedImport

Path	Card.	Type	Description
version	0..1	string	Version of the seed import format. Allowed values: v2
resources	0..*		Resources to be imported.
resources.resourceType	0..1	string	Type of resource.
resources.id	0..1	string	Identifier for the resource.
resources.meta	0..1	Object	Metadata for the resource.
filename	0..1	string	Name of the seed import file.
md5-hash	0..1	string	MD5 hash of the import file for integrity verification.

SubsNotification

Path	Card.	Type	Description
retried	0..1	boolean	Whether this notification is a retry.
retryOf	0..1	Reference	Reference to the original notification this is retrying. Allowed references: SubsSubscription
_source	0..1	string	System Property. DO NOT USE IT.
status	0..1	code	Status of the notification delivery. Allowed values: success | failed
subscription	0..1	Reference	Reference to the subscription that generated this notification. Allowed references: SubsSubscription
retries	0..*	Reference	References to retry notifications. Allowed references: SubsSubscription
duration	0..1	integer	Duration of the notification processing in milliseconds.
response	0..1	Object	Response received from the notification endpoint.
notification	0..1	Object	Content of the notification that was sent.

SubsSubscription

Path	Card.	Type	Description
trigger	0..1	Object	Events that trigger this subscription.
channel	1..1		Channel configuration for delivering notifications.
channel.timeout	0..1	integer	Timeout in milliseconds for notification delivery.
channel.heartbeatPeriod	0..1	integer	Period in milliseconds for sending heartbeat notifications.
channel.headers	0..1	Object	HTTP headers to include with notifications.
channel.type	1..1	code	Type of channel for notifications. Allowed values: rest-hook
channel.endpoint	1..1	url	URL endpoint where notifications are sent.
channel.payload	0..1		Content to be sent in the notification.
identifier	0..*	Identifier	Business identifiers for the subscription.
status	0..1	code	Current status of the subscription. Allowed values: active | off
_source	0..1	string	System Property. DO NOT USE IT.