organization affiliations

Create Organization Affiliation

post
/organizations/{organizationId}/fhir/4/OrganizationAffiliation

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a OrganizationAffiliation resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Business identifiers that are specific to this role.
activebooleanWhether this organization affiliation record is in active use.
periodPeriodThe period during which the participatingOrganization is affiliated with the primary organization.
organizationReferenceOrganization where the role is available (primary organization/has members).
participatingOrganizationReferenceThe Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
networkarray(Reference)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
codearray(CodeableConcept)Definition of the role the participatingOrganization plays in the association.
specialtyarray(CodeableConcept)Specific specialty of the participatingOrganization in the context of the role.
locationarray(Reference)The location(s) at which the role occurs.
healthcareServicearray(Reference)Healthcare services provided through the role.
telecomarray(ContactPoint)Contact details at the participatingOrganization relevant to this Affiliation.
endpointarray(Reference)Technical endpoints providing access to services operated for this role.

Response

Patch Organization Affiliation

patch
/organizations/{organizationId}/fhir/4/OrganizationAffiliation/{resourceId}

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

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a OrganizationAffiliation resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Business identifiers that are specific to this role.
activebooleanWhether this organization affiliation record is in active use.
periodPeriodThe period during which the participatingOrganization is affiliated with the primary organization.
organizationReferenceOrganization where the role is available (primary organization/has members).
participatingOrganizationReferenceThe Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
networkarray(Reference)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
codearray(CodeableConcept)Definition of the role the participatingOrganization plays in the association.
specialtyarray(CodeableConcept)Specific specialty of the participatingOrganization in the context of the role.
locationarray(Reference)The location(s) at which the role occurs.
healthcareServicearray(Reference)Healthcare services provided through the role.
telecomarray(ContactPoint)Contact details at the participatingOrganization relevant to this Affiliation.
endpointarray(Reference)Technical endpoints providing access to services operated for this role.

Response

Read Organization Affiliation

get
/organizations/{organizationId}/fhir/4/OrganizationAffiliation/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Organization Affiliation

get
/organizations/{organizationId}/fhir/4/OrganizationAffiliation/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Organization Affiliation

get
/organizations/{organizationId}/fhir/4/OrganizationAffiliation/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Organization Affiliation

delete
/organizations/{organizationId}/fhir/4/OrganizationAffiliation/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Organization Affiliation

get
/organizations/{organizationId}/fhir/4/OrganizationAffiliation

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
datestring
emailstring
endpointstring
identifierstring
locationstring
networkstring
participating-organizationstring
phonestring
primary-organizationstring
rolestring
servicestring
specialtystring
telecomstring

Params

organizationId*string|stringid|slug

Response

Search History Organization Affiliation

get
/organizations/{organizationId}/fhir/4/OrganizationAffiliation/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Organization Affiliation

post
/organizations/{organizationId}/fhir/4/OrganizationAffiliation/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
datestring
emailstring
endpointstring
identifierstring
locationstring
networkstring
participating-organizationstring
phonestring
primary-organizationstring
rolestring
servicestring
specialtystring
telecomstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a OrganizationAffiliation resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Business identifiers that are specific to this role.
activebooleanWhether this organization affiliation record is in active use.
periodPeriodThe period during which the participatingOrganization is affiliated with the primary organization.
organizationReferenceOrganization where the role is available (primary organization/has members).
participatingOrganizationReferenceThe Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
networkarray(Reference)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
codearray(CodeableConcept)Definition of the role the participatingOrganization plays in the association.
specialtyarray(CodeableConcept)Specific specialty of the participatingOrganization in the context of the role.
locationarray(Reference)The location(s) at which the role occurs.
healthcareServicearray(Reference)Healthcare services provided through the role.
telecomarray(ContactPoint)Contact details at the participatingOrganization relevant to this Affiliation.
endpointarray(Reference)Technical endpoints providing access to services operated for this role.

Response

Update Organization Affiliation

put
/organizations/{organizationId}/fhir/4/OrganizationAffiliation/{resourceId}

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a OrganizationAffiliation resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Business identifiers that are specific to this role.
activebooleanWhether this organization affiliation record is in active use.
periodPeriodThe period during which the participatingOrganization is affiliated with the primary organization.
organizationReferenceOrganization where the role is available (primary organization/has members).
participatingOrganizationReferenceThe Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
networkarray(Reference)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
codearray(CodeableConcept)Definition of the role the participatingOrganization plays in the association.
specialtyarray(CodeableConcept)Specific specialty of the participatingOrganization in the context of the role.
locationarray(Reference)The location(s) at which the role occurs.
healthcareServicearray(Reference)Healthcare services provided through the role.
telecomarray(ContactPoint)Contact details at the participatingOrganization relevant to this Affiliation.
endpointarray(Reference)Technical endpoints providing access to services operated for this role.

Response