Organization

Description

The FHIR Organization profile defines facilities.

See JSON structures below for examples.

References

  • Appears in PractitionerRole.organization references.
  • Appears in Location.managingOrganization references.

Snapshot

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeBindingFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeΣ ?!0..1boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameS Σ I1..1string
alias0..*string
id0..1string
extensionI0..*Extension
systemΣ I1..1codeBindingFixed Value
valueΣ1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
id0..1string
extensionI1..1Extension(Coding)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineS Σ1..1string
cityS Σ1..1string
districtΣ0..1stringBinding
stateΣ0..1string
postalCodeS Σ1..1string
countryS Σ1..1string
periodΣ I0..1Period
partOfΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
endpointI0..*Reference(Endpoint)

Click here for information about the base FHIR Organization specification.

JSON structure

These are templates for the FHIR Organization. See table below for values description.

Facility structure:

{
    "resourceType": "Organization",
    "id": "{id}",
    "meta": {
        "versionId": "{versionId}",
        "lastUpdated": "{lastUpdatedDate}",
        "profile":  [
            "http://fhir.akinox.com/r4b/StructureDefinition/Organization"
        ]
    },
    "identifier":  [
        {
            "type": {
                "coding":  [
                    {
                        "system": "http://akinox.com/fhir/ValueSet/akinox-identifier-type",
                        "code": "{identifierTypeMsss}"
                    }
                ]
            },
            "system": "urn:oid:2.16.124.10.101.1.60.101",
            "value": "{msssCode}"
        }
    ],
    "active": true,
    "type":  [
        {
            "coding":  [
                {
                    "system": "http://akinox.com/fhir/ValueSet/akinox-organization-type",
                    "code": "{typeCode}"
                }
            ],
            "text": "Installation"
        }
    ],
    "name": "{name}",
    "telecom":  [
        {
            "system": "phone",
            "value": "{workPhone}"
        }
    ],
    "address":  [
        {
            "extension":  [
                {
                    "url": "http://fhir.akinox.com/r4b/StructureDefinition/ext-address-quebec-msss-rts",
                    "valueCoding": {
                        "system": "http://akinox.com/fhir/ValueSet/address-quebec-msss-rts",
                        "code": "{rtsCode}",
                        "display": "{rtsDisplay}"
                    }
                }
            ],
            "type": "{addressType}",
            "line":  [
                "{lineAddress}"
            ],
            "city": "{city}",
            "district": "{district}",
            "postalCode": "{postalCode}",
            "country": "{country}"
        }
    ]
}

Description of the values

Property Description
{id} This is the logical identifier. It is a GUID for a Facility.
{versionId} The version number of the establishment. This version number is incremented by Akinox system outside of changes done trought this API.
{lastUpdatedDate} The last updated date of the establishment
{identifierTypeMsss} Identifier type for the facility. Is a fixed value. (i.e. MSSS, Minister for Health and Social Services)
{msssCode} This is the business identifier. It is the facility code for the Ministry of Health and Social Services (Ministère de la Santé et des Services Sociaux). varchar(9) max. Only present in facility structures.
{typeCode} This is the type of organization. See AkinoxOrganizationType ValueSet here.
{name} Name of the organization.
{workPhone} Telephone for the organization.
{rtsCode} The organization's territorial service area code (Réseaux territoriaux de services de santé et de services sociaux (RTS).
{rtsDisplay} The patient's RTS human readable display.
{addressType} Address type for the organization.
{lineAddress} Line address for the organization.
{city} The organization's city.
{district} Quebec MSSS administrative Region.
{postalCode} Postal code for the organization. Example (1A1 1N1)
{country} The organization's country code. As of Version 1, facility are in Canada. (CAN)

Notes on typical FHIR errors

  • Regarding the facility entity, the identifier.type.coding.code must always be MSSS. Otherwise, the FHIR validation will raise an error. (it is caps sensitive)
    • Click here for further information regarding the types of identifier.
  • The telecom.system must always be phone. Otherwise, the FHIR validation will raise an error.
  • If you remove the meta.profile, there will be an error on the FHIR validation.

Search Parameters

Name Description
identifier This is the unique business identifier of the organization. Identifies one unique facility.

See search examples