New post
AllAccepted answers
Ashok Kumar · Feb 3

Hello @Deepa Shahi

You can customize the SDA3 package. A native discrete SDA class is available to convert the data's from HL7 to FHIR and vise versa. In this case, HS.SDA3.Encounter is the SDA class. There is an additional editable extension class( "HS.Local.SDA3.EncounterExtension" - Encounter) available in these primary SDA classes to customize data elements. You can define all your required data elements in to this extension class and compile the package.

If you're using the SDA to FHIR conversion by DTL native approach.

Customize the DTL

You have to copy the existing DTL "HS.FHIR.DTL.SDA3.vR4.Encounter.Encounter" to "HS.Local.FHIR.DTL.SDA3.vR4.Encounter.Encounter". Before customizing DTLs, you need to specify a single package for all customized DTL classes. InterSystems recommends naming the class package: HS.Local.FHIR.DTL.

Now you can modify the newly copied DTL based on your requirement. this newly created DTL is not invoked by default. So, execute below code in your FHIR enabled namespace. The FHIR API classes use this HS.Local.* DTL packages while generating the resources ("Encounter" )

 set status = ##class(HS.FHIR.DTL.Util.API.ExecDefinition).SetCustomDTLPackage("HS.Local.FHIR.DTL")
Ashok Kumar · Jan 31

Hello @Gabriel Santos 

AFAIK, The required property keyword works on literal, Collection, stream, serial, object valued properties except the %DynamicArray and %DynamicObject. Because by default the property methods(Getter) was created and it assign the values for %DynamicArray is "[]" and "{}" for dynamicObject even though if you assign empty string it overwrites it. so, The %ValidateObject() doesn't include these two objects for validation.

Ashok Kumar · Jan 24

As you know the swagger is used to design the API documentation first, and then build the REST API based on that design. IRIS or other API systems don't inherently know about the payload, the return response, or the specific responses for status codes like 200, 400, or 500 unless it's specified.

You're right about the traditional approach. Creating REST services manually doesn't have knowledge of these details. It generates the Swagger documentation based on the information available in the UrlMap and the class method in the dispatch class. Add your comments on top of the class method (meta data details) will be set into the description in swagger

 
Spoiler

If you want your API to be well-documented, it’s better to follow a spec-first approach, as this approach captures crucial details like paths, method types, descriptions, path parameters, query parameters, and responses.

Thanks!

Ashok Kumar · Jan 23

Hello @Martin Nielsen

If you're mentioned the Return types( %Status or %Stream.Object) those are is IRIS specific and swagger 2.0 doesn't have those types . It has "response" object in swagger information/you have to define the response. ex: {"responses":{"200":{"description":"Successfully retrieved user","schema":{"$ref":"#/definitions/User"}},"404":{"description":"User not found"}}} 

Path Parameters are documented by default 
ex : "/mytest/{userid}"

"summary"  and "description"- you can use this OpenAPI properties to add description and additional information about the classmethod.

Please refer the below Swagger 2.0 sample.

note: If you're using spec-first approach. You need to do all the changes in .Impl class not in .disp class. Because .disp is generated class and it will be overwritten once .spec class compiled(updating swagger).

Swagger

 
Spoiler

.disp class

 
Spoiler
Ashok Kumar · Jan 21

Hello @Pietro Di Leo

AFAIK, There is no direct execution of the IndexKeyOpen  and other generated methods  in python. We can write a wrapper method to run those methods.

Class pylearn.NewClass2 Extends %Persistent
{

Property Code As %String(MAXLEN = 50) [ Required ];
Index CodeIdx On Code [ Unique ];
ClassMethod RunCode() [ Language = python ]
{
    import iris
    iris_obj =  iris.cls(__name__).GeObjByIdx("CodeIdx","A212")
    print(iris_obj.Code)
}

ClassMethod GeObjByIdx(IndexName, ID)
{
	Return $ClassMethod(,IndexName_"Open",ID)
}
}
Ashok Kumar · Jan 13

Hello @omer 

The above same is ACID complaint when using transactions. It will be reverted  to old value under transaction rollback. However, The counter values are incremented by  $Increment and $Sequence are will not changed even rollback.

LEARNING>w ^myTracker("onSomething")
1
LEARNING>ts
 
TL1:LEARNING>s ^myTracker("onSomething")=12
 
TL1:LEARNING>w ^myTracker("onSomething")
12
TL1:LEARNING>trollback
 
LEARNING>w ^myTracker("onSomething")
1
LEARNING>

$Increment and $sequence

LEARNING>write ^myTracker("onSomething")
1
LEARNING>tstart
 
TL1:LEARNING>do $Increment(^myTracker("onSomething"))
 
TL1:LEARNING>write ^myTracker("onSomething")
2
TL1:LEARNING>trollback
 
LEARNING>write ^myTracker("onSomething")
2
LEARNING>
Ashok Kumar · Dec 12, 2024

:clear deletes all the commands in that particular process/recall buffer. If you open another terminal and :history shows all commands. So, I thought some native commands exist like :clear to delete the commands history permanently. 

!del %USERPROFILE%\.iris_history - yes, we can the use the file system commands.

Thanks!

Ashok Kumar · Dec 11, 2024

Hello @Enrico Parisi 

I'm expect/built in method to generate the below HTTP request and HTTP response from %Net.HttpRequest. which was shown in the "View HTTP Trace" option in web gateway.

POST /aktest/test HTTP/1.1
Content-Type: application/fhir+json
Accept: */*
Host: localhost:52773
Accept-Encoding: gzip, deflate, br
Content-Length: 21

{ "asd":"asd" }
Ashok Kumar · Nov 21, 2024

Are you able to set those Status and HTTPheaders straight into the instance of EnsLib.HTTP.GenericMessage in your code. like below

Set httpGeneric = ##Class(EnsLib.HTTP.GenericMessage).%New() ; this was already initiated in your business host via code.
set att("Status")=..#HTTP400BADREQUEST
do httpGeneric.SetAttributes(.att)
set httpHeader("ContentType")="application/json"
set httpHeader("totalcount")=totalcount
do httpGeneric.SetHTTPHeaders(.httpHeader)