Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.OrganizationAffiliation extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = OrganizationAffiliation;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = OrganizationAffiliation;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property active as %Boolean (XMLNAME = "active", XMLPROJECTION = "ATTRIBUTE");

Whether this organization affiliation record is in active use.

Property methods: activeDisplayToLogical(), activeGet(), activeIsValid(), activeLogicalToDisplay(), activeLogicalToXSD(), activeNormalize(), activeSet(), activeXSDToLogical()
property code as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");

Definition of the role the participatingOrganization plays.

any FHIR4 code may be used; organization-role shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property endpoint as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");

Technical endpoints providing access to services operated for this role.


Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property healthcareService as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "healthcareService", XMLPROJECTION = "ELEMENT");

Healthcare services provided through the role.


Property methods: healthcareServiceBuildValueArray(), healthcareServiceCollectionToDisplay(), healthcareServiceCollectionToOdbc(), healthcareServiceDisplayToCollection(), healthcareServiceGet(), healthcareServiceGetObject(), healthcareServiceGetObjectId(), healthcareServiceGetSwizzled(), healthcareServiceIsValid(), healthcareServiceOdbcToCollection(), healthcareServiceSet(), healthcareServiceSetObject(), healthcareServiceSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business identifiers that are specific to this role.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");

The location(s) at which the role occurs.


Property methods: locationBuildValueArray(), locationCollectionToDisplay(), locationCollectionToOdbc(), locationDisplayToCollection(), locationGet(), locationGetObject(), locationGetObjectId(), locationGetSwizzled(), locationIsValid(), locationOdbcToCollection(), locationSet(), locationSetObject(), locationSetObjectId()
property network as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "network", XMLPROJECTION = "ELEMENT");

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)


Property methods: networkBuildValueArray(), networkCollectionToDisplay(), networkCollectionToOdbc(), networkDisplayToCollection(), networkGet(), networkGetObject(), networkGetObjectId(), networkGetSwizzled(), networkIsValid(), networkOdbcToCollection(), networkSet(), networkSetObject(), networkSetObjectId()
property organization as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");

Organization where the role is available.


Property methods: organizationGet(), organizationGetSwizzled(), organizationIsValid(), organizationNewObject(), organizationSet()
property participatingOrganization as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "participatingOrganization", XMLPROJECTION = "ELEMENT");

Organization that provides/performs the role (e.g. providing services or is a member of)


Property methods: participatingOrganizationGet(), participatingOrganizationGetSwizzled(), participatingOrganizationIsValid(), participatingOrganizationNewObject(), participatingOrganizationSet()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

The period during which the participatingOrganization is affiliated with the primary organization.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property specialty as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");

Specific specialty of the participatingOrganization in the context of the role.

c80-practice-codes is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in c80-practice-codes, you may use codes from any ValueSet.

Property methods: specialtyBuildValueArray(), specialtyCollectionToDisplay(), specialtyCollectionToOdbc(), specialtyDisplayToCollection(), specialtyGet(), specialtyGetObject(), specialtyGetObjectId(), specialtyGetSwizzled(), specialtyIsValid(), specialtyOdbcToCollection(), specialtySet(), specialtySetObject(), specialtySetObjectId()
property telecom as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");

Contact details at the participatingOrganization relevant to this Affiliation.

Property methods: telecomBuildValueArray(), telecomCollectionToDisplay(), telecomCollectionToOdbc(), telecomDisplayToCollection(), telecomGet(), telecomGetObject(), telecomGetObjectId(), telecomGetSwizzled(), telecomIsValid(), telecomOdbcToCollection(), telecomSet(), telecomSetObject(), telecomSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab