1. Packages
  2. Hsdp Provider
  3. API Docs
  4. CdrPractitioner
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.CdrPractitioner

Explore with Pulumi AI

Provides a resource for creating Practitioner FHIR resources in CDR. This resource provides limited management of the Practioner resource.

Example Usage

The following example creates a FHIR Organisation and a Practitioner associated with it.

import * as pulumi from "@pulumi/pulumi";
import * as hsdp from "@pulumi/hsdp";

const sandbox = hsdp.getCdrFhirStore({
    baseUrl: "https://cdr-stu3-sandbox.hsdp.io",
    fhirOrgId: _var.root_org_id,
});
const hospital = new hsdp.CdrOrg("hospital", {
    fhirStore: sandbox.then(sandbox => sandbox.endpoint),
    orgId: _var.sub_org_id,
    version: "r4",
    partOf: _var.root_org_id,
    purgeDelete: false,
});
const practitioner = new hsdp.CdrPractitioner("practitioner", {
    fhirStore: hospital.fhirStore,
    version: "r4",
    identifiers: [{
        system: "https://iam.hsdp.io",
        value: "xx-xx",
        use: "actual",
    }],
    names: [{
        text: "Ron Swanson",
        givens: ["Ron"],
        family: "Swanson",
    }],
});
Copy
import pulumi
import pulumi_hsdp as hsdp

sandbox = hsdp.get_cdr_fhir_store(base_url="https://cdr-stu3-sandbox.hsdp.io",
    fhir_org_id=var["root_org_id"])
hospital = hsdp.CdrOrg("hospital",
    fhir_store=sandbox.endpoint,
    org_id=var["sub_org_id"],
    version="r4",
    part_of=var["root_org_id"],
    purge_delete=False)
practitioner = hsdp.CdrPractitioner("practitioner",
    fhir_store=hospital.fhir_store,
    version="r4",
    identifiers=[{
        "system": "https://iam.hsdp.io",
        "value": "xx-xx",
        "use": "actual",
    }],
    names=[{
        "text": "Ron Swanson",
        "givens": ["Ron"],
        "family": "Swanson",
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sandbox, err := hsdp.GetCdrFhirStore(ctx, &hsdp.GetCdrFhirStoreArgs{
			BaseUrl:   "https://cdr-stu3-sandbox.hsdp.io",
			FhirOrgId: _var.Root_org_id,
		}, nil)
		if err != nil {
			return err
		}
		hospital, err := hsdp.NewCdrOrg(ctx, "hospital", &hsdp.CdrOrgArgs{
			FhirStore:   pulumi.String(sandbox.Endpoint),
			OrgId:       pulumi.Any(_var.Sub_org_id),
			Version:     pulumi.String("r4"),
			PartOf:      pulumi.Any(_var.Root_org_id),
			PurgeDelete: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = hsdp.NewCdrPractitioner(ctx, "practitioner", &hsdp.CdrPractitionerArgs{
			FhirStore: hospital.FhirStore,
			Version:   pulumi.String("r4"),
			Identifiers: hsdp.CdrPractitionerIdentifierArray{
				&hsdp.CdrPractitionerIdentifierArgs{
					System: pulumi.String("https://iam.hsdp.io"),
					Value:  pulumi.String("xx-xx"),
					Use:    pulumi.String("actual"),
				},
			},
			Names: hsdp.CdrPractitionerNameArray{
				&hsdp.CdrPractitionerNameArgs{
					Text: pulumi.String("Ron Swanson"),
					Givens: pulumi.StringArray{
						pulumi.String("Ron"),
					},
					Family: pulumi.String("Swanson"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Hsdp = Pulumi.Hsdp;

return await Deployment.RunAsync(() => 
{
    var sandbox = Hsdp.GetCdrFhirStore.Invoke(new()
    {
        BaseUrl = "https://cdr-stu3-sandbox.hsdp.io",
        FhirOrgId = @var.Root_org_id,
    });

    var hospital = new Hsdp.CdrOrg("hospital", new()
    {
        FhirStore = sandbox.Apply(getCdrFhirStoreResult => getCdrFhirStoreResult.Endpoint),
        OrgId = @var.Sub_org_id,
        Version = "r4",
        PartOf = @var.Root_org_id,
        PurgeDelete = false,
    });

    var practitioner = new Hsdp.CdrPractitioner("practitioner", new()
    {
        FhirStore = hospital.FhirStore,
        Version = "r4",
        Identifiers = new[]
        {
            new Hsdp.Inputs.CdrPractitionerIdentifierArgs
            {
                System = "https://iam.hsdp.io",
                Value = "xx-xx",
                Use = "actual",
            },
        },
        Names = new[]
        {
            new Hsdp.Inputs.CdrPractitionerNameArgs
            {
                Text = "Ron Swanson",
                Givens = new[]
                {
                    "Ron",
                },
                Family = "Swanson",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hsdp.HsdpFunctions;
import com.pulumi.hsdp.inputs.GetCdrFhirStoreArgs;
import com.pulumi.hsdp.CdrOrg;
import com.pulumi.hsdp.CdrOrgArgs;
import com.pulumi.hsdp.CdrPractitioner;
import com.pulumi.hsdp.CdrPractitionerArgs;
import com.pulumi.hsdp.inputs.CdrPractitionerIdentifierArgs;
import com.pulumi.hsdp.inputs.CdrPractitionerNameArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var sandbox = HsdpFunctions.getCdrFhirStore(GetCdrFhirStoreArgs.builder()
            .baseUrl("https://cdr-stu3-sandbox.hsdp.io")
            .fhirOrgId(var_.root_org_id())
            .build());

        var hospital = new CdrOrg("hospital", CdrOrgArgs.builder()
            .fhirStore(sandbox.applyValue(getCdrFhirStoreResult -> getCdrFhirStoreResult.endpoint()))
            .orgId(var_.sub_org_id())
            .version("r4")
            .partOf(var_.root_org_id())
            .purgeDelete(false)
            .build());

        var practitioner = new CdrPractitioner("practitioner", CdrPractitionerArgs.builder()
            .fhirStore(hospital.fhirStore())
            .version("r4")
            .identifiers(CdrPractitionerIdentifierArgs.builder()
                .system("https://iam.hsdp.io")
                .value("xx-xx")
                .use("actual")
                .build())
            .names(CdrPractitionerNameArgs.builder()
                .text("Ron Swanson")
                .givens("Ron")
                .family("Swanson")
                .build())
            .build());

    }
}
Copy
resources:
  hospital:
    type: hsdp:CdrOrg
    properties:
      fhirStore: ${sandbox.endpoint}
      orgId: ${var.sub_org_id}
      # Set up this org to use FHIR R4
      version: r4
      partOf: ${var.root_org_id}
      purgeDelete: false
  practitioner:
    type: hsdp:CdrPractitioner
    properties:
      fhirStore: ${hospital.fhirStore}
      version: r4
      identifiers:
        - system: https://iam.hsdp.io
          value: xx-xx
          use: actual
      names:
        - text: Ron Swanson
          givens:
            - Ron
          family: Swanson
variables:
  sandbox:
    fn::invoke:
      function: hsdp:getCdrFhirStore
      arguments:
        baseUrl: https://cdr-stu3-sandbox.hsdp.io
        fhirOrgId: ${var.root_org_id}
Copy

Create CdrPractitioner Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CdrPractitioner(name: string, args: CdrPractitionerArgs, opts?: CustomResourceOptions);
@overload
def CdrPractitioner(resource_name: str,
                    args: CdrPractitionerArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def CdrPractitioner(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    fhir_store: Optional[str] = None,
                    identifiers: Optional[Sequence[CdrPractitionerIdentifierArgs]] = None,
                    names: Optional[Sequence[CdrPractitionerNameArgs]] = None,
                    cdr_practitioner_id: Optional[str] = None,
                    soft_delete: Optional[bool] = None,
                    version: Optional[str] = None)
func NewCdrPractitioner(ctx *Context, name string, args CdrPractitionerArgs, opts ...ResourceOption) (*CdrPractitioner, error)
public CdrPractitioner(string name, CdrPractitionerArgs args, CustomResourceOptions? opts = null)
public CdrPractitioner(String name, CdrPractitionerArgs args)
public CdrPractitioner(String name, CdrPractitionerArgs args, CustomResourceOptions options)
type: hsdp:CdrPractitioner
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CdrPractitionerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CdrPractitionerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CdrPractitionerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CdrPractitionerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CdrPractitionerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var cdrPractitionerResource = new Hsdp.CdrPractitioner("cdrPractitionerResource", new()
{
    FhirStore = "string",
    Identifiers = new[]
    {
        new Hsdp.Inputs.CdrPractitionerIdentifierArgs
        {
            System = "string",
            Value = "string",
            Use = "string",
        },
    },
    Names = new[]
    {
        new Hsdp.Inputs.CdrPractitionerNameArgs
        {
            Family = "string",
            Givens = new[]
            {
                "string",
            },
            Text = "string",
        },
    },
    CdrPractitionerId = "string",
    SoftDelete = false,
    Version = "string",
});
Copy
example, err := hsdp.NewCdrPractitioner(ctx, "cdrPractitionerResource", &hsdp.CdrPractitionerArgs{
	FhirStore: pulumi.String("string"),
	Identifiers: hsdp.CdrPractitionerIdentifierArray{
		&hsdp.CdrPractitionerIdentifierArgs{
			System: pulumi.String("string"),
			Value:  pulumi.String("string"),
			Use:    pulumi.String("string"),
		},
	},
	Names: hsdp.CdrPractitionerNameArray{
		&hsdp.CdrPractitionerNameArgs{
			Family: pulumi.String("string"),
			Givens: pulumi.StringArray{
				pulumi.String("string"),
			},
			Text: pulumi.String("string"),
		},
	},
	CdrPractitionerId: pulumi.String("string"),
	SoftDelete:        pulumi.Bool(false),
	Version:           pulumi.String("string"),
})
Copy
var cdrPractitionerResource = new CdrPractitioner("cdrPractitionerResource", CdrPractitionerArgs.builder()
    .fhirStore("string")
    .identifiers(CdrPractitionerIdentifierArgs.builder()
        .system("string")
        .value("string")
        .use("string")
        .build())
    .names(CdrPractitionerNameArgs.builder()
        .family("string")
        .givens("string")
        .text("string")
        .build())
    .cdrPractitionerId("string")
    .softDelete(false)
    .version("string")
    .build());
Copy
cdr_practitioner_resource = hsdp.CdrPractitioner("cdrPractitionerResource",
    fhir_store="string",
    identifiers=[{
        "system": "string",
        "value": "string",
        "use": "string",
    }],
    names=[{
        "family": "string",
        "givens": ["string"],
        "text": "string",
    }],
    cdr_practitioner_id="string",
    soft_delete=False,
    version="string")
Copy
const cdrPractitionerResource = new hsdp.CdrPractitioner("cdrPractitionerResource", {
    fhirStore: "string",
    identifiers: [{
        system: "string",
        value: "string",
        use: "string",
    }],
    names: [{
        family: "string",
        givens: ["string"],
        text: "string",
    }],
    cdrPractitionerId: "string",
    softDelete: false,
    version: "string",
});
Copy
type: hsdp:CdrPractitioner
properties:
    cdrPractitionerId: string
    fhirStore: string
    identifiers:
        - system: string
          use: string
          value: string
    names:
        - family: string
          givens:
            - string
          text: string
    softDelete: false
    version: string
Copy

CdrPractitioner Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CdrPractitioner resource accepts the following input properties:

FhirStore This property is required. string
Identifiers This property is required. List<CdrPractitionerIdentifier>
The FHIR identifier block
Names This property is required. List<CdrPractitionerName>
The FHIR name block
CdrPractitionerId string
The unique GUID of the practitioner in the CDR instance
SoftDelete bool
Version string
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
FhirStore This property is required. string
Identifiers This property is required. []CdrPractitionerIdentifierArgs
The FHIR identifier block
Names This property is required. []CdrPractitionerNameArgs
The FHIR name block
CdrPractitionerId string
The unique GUID of the practitioner in the CDR instance
SoftDelete bool
Version string
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
fhirStore This property is required. String
identifiers This property is required. List<CdrPractitionerIdentifier>
The FHIR identifier block
names This property is required. List<CdrPractitionerName>
The FHIR name block
cdrPractitionerId String
The unique GUID of the practitioner in the CDR instance
softDelete Boolean
version String
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
fhirStore This property is required. string
identifiers This property is required. CdrPractitionerIdentifier[]
The FHIR identifier block
names This property is required. CdrPractitionerName[]
The FHIR name block
cdrPractitionerId string
The unique GUID of the practitioner in the CDR instance
softDelete boolean
version string
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
fhir_store This property is required. str
identifiers This property is required. Sequence[CdrPractitionerIdentifierArgs]
The FHIR identifier block
names This property is required. Sequence[CdrPractitionerNameArgs]
The FHIR name block
cdr_practitioner_id str
The unique GUID of the practitioner in the CDR instance
soft_delete bool
version str
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
fhirStore This property is required. String
identifiers This property is required. List<Property Map>
The FHIR identifier block
names This property is required. List<Property Map>
The FHIR name block
cdrPractitionerId String
The unique GUID of the practitioner in the CDR instance
softDelete Boolean
version String
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3

Outputs

All input properties are implicitly available as output properties. Additionally, the CdrPractitioner resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
LastUpdated string
Last update time
VersionId string
The version of the resource
Id string
The provider-assigned unique ID for this managed resource.
LastUpdated string
Last update time
VersionId string
The version of the resource
id String
The provider-assigned unique ID for this managed resource.
lastUpdated String
Last update time
versionId String
The version of the resource
id string
The provider-assigned unique ID for this managed resource.
lastUpdated string
Last update time
versionId string
The version of the resource
id str
The provider-assigned unique ID for this managed resource.
last_updated str
Last update time
version_id str
The version of the resource
id String
The provider-assigned unique ID for this managed resource.
lastUpdated String
Last update time
versionId String
The version of the resource

Look up Existing CdrPractitioner Resource

Get an existing CdrPractitioner resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CdrPractitionerState, opts?: CustomResourceOptions): CdrPractitioner
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cdr_practitioner_id: Optional[str] = None,
        fhir_store: Optional[str] = None,
        identifiers: Optional[Sequence[CdrPractitionerIdentifierArgs]] = None,
        last_updated: Optional[str] = None,
        names: Optional[Sequence[CdrPractitionerNameArgs]] = None,
        soft_delete: Optional[bool] = None,
        version: Optional[str] = None,
        version_id: Optional[str] = None) -> CdrPractitioner
func GetCdrPractitioner(ctx *Context, name string, id IDInput, state *CdrPractitionerState, opts ...ResourceOption) (*CdrPractitioner, error)
public static CdrPractitioner Get(string name, Input<string> id, CdrPractitionerState? state, CustomResourceOptions? opts = null)
public static CdrPractitioner get(String name, Output<String> id, CdrPractitionerState state, CustomResourceOptions options)
resources:  _:    type: hsdp:CdrPractitioner    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CdrPractitionerId string
The unique GUID of the practitioner in the CDR instance
FhirStore string
Identifiers List<CdrPractitionerIdentifier>
The FHIR identifier block
LastUpdated string
Last update time
Names List<CdrPractitionerName>
The FHIR name block
SoftDelete bool
Version string
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
VersionId string
The version of the resource
CdrPractitionerId string
The unique GUID of the practitioner in the CDR instance
FhirStore string
Identifiers []CdrPractitionerIdentifierArgs
The FHIR identifier block
LastUpdated string
Last update time
Names []CdrPractitionerNameArgs
The FHIR name block
SoftDelete bool
Version string
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
VersionId string
The version of the resource
cdrPractitionerId String
The unique GUID of the practitioner in the CDR instance
fhirStore String
identifiers List<CdrPractitionerIdentifier>
The FHIR identifier block
lastUpdated String
Last update time
names List<CdrPractitionerName>
The FHIR name block
softDelete Boolean
version String
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
versionId String
The version of the resource
cdrPractitionerId string
The unique GUID of the practitioner in the CDR instance
fhirStore string
identifiers CdrPractitionerIdentifier[]
The FHIR identifier block
lastUpdated string
Last update time
names CdrPractitionerName[]
The FHIR name block
softDelete boolean
version string
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
versionId string
The version of the resource
cdr_practitioner_id str
The unique GUID of the practitioner in the CDR instance
fhir_store str
identifiers Sequence[CdrPractitionerIdentifierArgs]
The FHIR identifier block
last_updated str
Last update time
names Sequence[CdrPractitionerNameArgs]
The FHIR name block
soft_delete bool
version str
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
version_id str
The version of the resource
cdrPractitionerId String
The unique GUID of the practitioner in the CDR instance
fhirStore String
identifiers List<Property Map>
The FHIR identifier block
lastUpdated String
Last update time
names List<Property Map>
The FHIR name block
softDelete Boolean
version String
The FHIR version to use. Options [ stu3 | r4 ]. Default is stu3
versionId String
The version of the resource

Supporting Types

CdrPractitionerIdentifier
, CdrPractitionerIdentifierArgs

System This property is required. string
The system of the identifier e.g. HSP IAM
Value This property is required. string
the identifier value e.g. the IAM GUID of the practitioner
Use string
System This property is required. string
The system of the identifier e.g. HSP IAM
Value This property is required. string
the identifier value e.g. the IAM GUID of the practitioner
Use string
system This property is required. String
The system of the identifier e.g. HSP IAM
value This property is required. String
the identifier value e.g. the IAM GUID of the practitioner
use String
system This property is required. string
The system of the identifier e.g. HSP IAM
value This property is required. string
the identifier value e.g. the IAM GUID of the practitioner
use string
system This property is required. str
The system of the identifier e.g. HSP IAM
value This property is required. str
the identifier value e.g. the IAM GUID of the practitioner
use str
system This property is required. String
The system of the identifier e.g. HSP IAM
value This property is required. String
the identifier value e.g. the IAM GUID of the practitioner
use String

CdrPractitionerName
, CdrPractitionerNameArgs

Family This property is required. string
Givens This property is required. List<string>
) The list of given names
Text This property is required. string
The text representation of the name
Family This property is required. string
Givens This property is required. []string
) The list of given names
Text This property is required. string
The text representation of the name
family This property is required. String
givens This property is required. List<String>
) The list of given names
text This property is required. String
The text representation of the name
family This property is required. string
givens This property is required. string[]
) The list of given names
text This property is required. string
The text representation of the name
family This property is required. str
givens This property is required. Sequence[str]
) The list of given names
text This property is required. str
The text representation of the name
family This property is required. String
givens This property is required. List<String>
) The list of given names
text This property is required. String
The text representation of the name

Import

Importing practitioners is currently not supported

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
hsdp philips-software/terraform-provider-hsdp
License
Notes
This Pulumi package is based on the hsdp Terraform Provider.