Skip to content

[HealthSamurai/sansara#8017] Update docs after /fhir/FHIRSchema removal #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryukzak merged 1 commit into from
Jul 22, 2026
Merged

[HealthSamurai/sansara#8017] Update docs after /fhir/FHIRSchema removal #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
305 changes: 180 additions & 125 deletions ...ns/aidbox-+-fhir-app-portal/getting-started/run-aidbox-+-fhir-portal-locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,32 +360,58 @@ Create `initBundleDeveloper.json` file in the same folder alongside with `docker
"entry": [
{
"resource": {
"resourceType": "FHIRSchema",
"resourceType": "StructureDefinition",
"url": "http://aidbox.app/StructureDefinition/Client/created-by",
"id": "client-created-by",
"base": "Extension",
"name": "client-created-by",
"status": "active",
"abstract": false,
"kind": "complex-type",
"type": "Extension",
"version": "0.0.1",
"elements": {
"url": {
"fixed": "http://aidbox.app/StructureDefinition/Client/created-by"
},
"value": {
"choices": ["valueReference"]
},
"valueReference": {
"type": "Reference",
"refers": ["User"],
"choiceOf": "value"
"context": [
{
"type": "element",
"expression": "Client"
}
},
"derivation": "constraint"
],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"version": "0.0.1",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"min": 0,
"max": "1"
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"fixedUri": "http://aidbox.app/StructureDefinition/Client/created-by"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://health-samurai.io/fhir/core/StructureDefinition/User"
]
}
]
}
]
}
},
"request": {
"method": "PUT",
"url": "FHIRSchema/client-created-by"
"url": "StructureDefinition/client-created-by"
}
},
{
Expand All @@ -408,37 +434,63 @@ Create `initBundleDeveloper.json` file in the same folder alongside with `docker
},
{
"resource": {
"resourceType": "FHIRSchema",
"resourceType": "StructureDefinition",
"url": "http://aidbox.app/StructureDefinition/Client/status",
"id": "client-status",
"base": "Extension",
"name": "client-status",
"status": "active",
"abstract": false,
"kind": "complex-type",
"type": "Extension",
"context": [
{
"type": "element",
"expression": "Client"
}
],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"version": "0.0.2",
"elements": {
"url": {
"fixed": "http://aidbox.app/StructureDefinition/Client/status"
},
"value": {
"choices": ["valueCode"]
},
"valueCode": {
"type": "code",
"choiceOf": "value",
"constraints": {
"enum-client-status": {
"severity": "error",
"expression": "%context.subsetOf('draft' | 'review' | 'active' | 'rejected')"
}
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"min": 0,
"max": "1"
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"fixedUri": "http://aidbox.app/StructureDefinition/Client/status"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "enum-client-status",
"severity": "error",
"human": "Status should be 'draft', 'review', 'active' or 'rejected'",
"expression": "%context.subsetOf('draft' | 'review' | 'active' | 'rejected')"
}
]
}
}
},
"derivation": "constraint"
]
}
},
"request": {
"method": "PUT",
"url": "FHIRSchema/client-status"
"url": "StructureDefinition/client-status"
}
},
{
Expand Down Expand Up @@ -1009,32 +1061,58 @@ Create `initBundleAdmin.json` file in the same folder alongside with `docker-com
"entry": [
{
"resource": {
"resourceType": "FHIRSchema",
"resourceType": "StructureDefinition",
"url": "http://aidbox.app/StructureDefinition/Client/created-by",
"id": "client-created-by",
"base": "Extension",
"name": "client-created-by",
"status": "active",
"abstract": false,
"kind": "complex-type",
"type": "Extension",
"version": "0.0.1",
"elements": {
"url": {
"fixed": "http://aidbox.app/StructureDefinition/Client/created-by"
},
"value": {
"choices": ["valueReference"]
},
"valueReference": {
"type": "Reference",
"refers": ["User"],
"choiceOf": "value"
"context": [
{
"type": "element",
"expression": "Client"
}
},
"derivation": "constraint"
],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"version": "0.0.1",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"min": 0,
"max": "1"
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"fixedUri": "http://aidbox.app/StructureDefinition/Client/created-by"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://health-samurai.io/fhir/core/StructureDefinition/User"
]
}
]
}
]
}
},
"request": {
"method": "PUT",
"url": "FHIRSchema/client-created-by"
"url": "StructureDefinition/client-created-by"
}
},
{
Expand All @@ -1057,37 +1135,63 @@ Create `initBundleAdmin.json` file in the same folder alongside with `docker-com
},
{
"resource": {
"resourceType": "FHIRSchema",
"resourceType": "StructureDefinition",
"url": "http://aidbox.app/StructureDefinition/Client/status",
"id": "client-status",
"base": "Extension",
"name": "client-status",
"status": "active",
"abstract": false,
"kind": "complex-type",
"type": "Extension",
"context": [
{
"type": "element",
"expression": "Client"
}
],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"version": "0.0.2",
"elements": {
"url": {
"fixed": "http://aidbox.app/StructureDefinition/Client/status"
},
"value": {
"choices": ["valueCode"]
},
"valueCode": {
"type": "code",
"choiceOf": "value",
"constraints": {
"enum-client-status": {
"severity": "error",
"expression": "%context.subsetOf('draft' | 'review' | 'active' | 'rejected')"
}
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"min": 0,
"max": "1"
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"fixedUri": "http://aidbox.app/StructureDefinition/Client/status"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "enum-client-status",
"severity": "error",
"human": "Status should be 'draft', 'review', 'active' or 'rejected'",
"expression": "%context.subsetOf('draft' | 'review' | 'active' | 'rejected')"
}
]
}
}
},
"derivation": "constraint"
]
}
},
"request": {
"method": "PUT",
"url": "FHIRSchema/client-status"
"url": "StructureDefinition/client-status"
}
},
{
Expand Down Expand Up @@ -1383,55 +1487,6 @@ Create `initBundleAdmin.json` file in the same folder alongside with `docker-com
"url": "DocumentReference/smartbox-privacy"
}
},
{
"resource": {
"resourceType": "FHIRSchema",
"url": "http://smartbox.hs/StructureDefinition/AwsAccount",
"id": "AwsAccount",
"name": "AwsAccount",
"type": "AwsAccount",
"kind": "resource",
"derivation": "specialization",
"elements": {
"region": {
"type": "string"
},
"access-key-id": {
"type": "string"
},
"secret-access-key": {
"type": "string"
}
}
},
"request": {
"method": "PUT",
"url": "FHIRSchema/AwsAccount"
}
},
{
"resource": {
"resourceType": "FHIRSchema",
"url": "http://smartbox.hs/StructureDefinition/GcpServiceAccount",
"id": "GcpServiceAccount",
"name": "GcpServiceAccount",
"type": "GcpServiceAccount",
"kind": "resource",
"derivation": "specialization",
"elements": {
"private-key": {
"type": "string"
},
"service-account-email": {
"type": "string"
}
}
},
"request": {
"method": "PUT",
"url": "FHIRSchema/GcpServiceAccount"
}
},
{
"resource": {
"resourceType": "AuthConfig",
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/artifact-registry-tutorials/custom-resources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Use FHIR StructureDefinition or FHIR Schema to define a custom resource. Althoug
\
Aidbox provides the following mechanisms to create custom resource types:
- [Using StructureDefnition](./custom-resources-using-structuredefinition.md) FHIR resource.
- [Using FHIRSchema](./custom-resources-using-fhir-schema.md) custom Aidbox resource.
- [Using FHIRSchema](./custom-resources-using-fhir-schema.md) custom Aidbox resource — available in Aidbox versions 2606 and earlier; the `POST/PUT /fhir/FHIRSchema` endpoints were removed in the July 2026 release.
Loading
Loading