Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: Organization
| Official URL: https://ancode.app/fhir/StructureDefinition/Organization | Version: 0.2.0 | |||
| Draft as of 2023-08-28 | Computable Name: Organization | |||
Usage:
- Refer to this Resource Profile:
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Organization.identifier.type | required | IdentifierTypeOrganization |
| Organization.type | required | OrganizationType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ide-1 | error | Organization.identifier | The Resource must have at least one Oficial Identifier : | |
| org-4 | error | Organization.identifier | CNPJ validation : | |
| org-5 | error | Organization | When type is HealthcareProvider, Location is required : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose org-5: When type is HealthcareProvider, Location is required |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 terminologyType | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/TerminologyType Binding: TerminologyType (required): TerminologyType | |
| typeHealthcareFacility | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/TypeHealthcareFacility Binding: BRTipoEstabelecimentoSaude (required): TypeHealthcareFacility | |
| serviceBillingTable | 0..1 | Reference(Organization) | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ServiceBillingTable | |
| medicationBillingTable | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/MedicationBillingTable | |
| deviceBillingTable | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/DeviceBillingTable | |
| bankAccount | 0..* | (Complex) | Extension URL: https://ancode.app/fhir/StructureDefinition/BankAccount | |
| biometricsSettings | 0..1 | (Complex) | Extension URL: https://ancode.app/fhir/StructureDefinition/BiometricsSettings | |
| Attachment | 0..1 | Attachment | Extension URL: https://ancode.app/fhir/StructureDefinition/Attachment | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
  identifier | C | 1..* | Identifier | An identifier intended for computation org-4: CNPJ validation |
 use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeOrganization (required) |
 coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
| type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
| name | ΣC | 1..1 | string | Name used for the organization |
| alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| address | C | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Organization.identifier.use | required | IdentifierUse |
| Organization.identifier.type | required | IdentifierTypeOrganization |
| Organization.type | required | OrganizationType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ide-1 | error | Organization.identifier | The Resource must have at least one Oficial Identifier : | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-4 | error | Organization.identifier | CNPJ validation : | |
| org-5 | error | Organization | When type is HealthcareProvider, Location is required : |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose org-5: When type is HealthcareProvider, Location is required | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| terminologyType | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/TerminologyType Binding: TerminologyType (required): TerminologyType | |||||
| typeHealthcareFacility | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/TypeHealthcareFacility Binding: BRTipoEstabelecimentoSaude (required): TypeHealthcareFacility | |||||
| serviceBillingTable | 0..1 | Reference(Organization) | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ServiceBillingTable | |||||
| medicationBillingTable | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/MedicationBillingTable | |||||
| deviceBillingTable | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/DeviceBillingTable | |||||
| bankAccount | 0..* | (Complex) | Extension URL: https://ancode.app/fhir/StructureDefinition/BankAccount | |||||
| biometricsSettings | 0..1 | (Complex) | Extension URL: https://ancode.app/fhir/StructureDefinition/BiometricsSettings | |||||
| Attachment | 0..1 | Attachment | Extension URL: https://ancode.app/fhir/StructureDefinition/Attachment | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | C | 1..* | Identifier | An identifier intended for computation org-4: CNPJ validation | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeOrganization (required) | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
  assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
 id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 1..1 | string | Text alternative for the resource | ||||
| active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: OrganizationType (required) | ||||
| name | ΣC | 1..1 | string | Name used for the organization | ||||
| alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| address | C | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name | 0..1 | HumanName | A name associated with the contact | |||||
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.identifier.use | required | IdentifierUse | ||||
| Organization.identifier.type | required | IdentifierTypeOrganization | ||||
| Organization.identifier.assigner.type | extensible | ResourceType | ||||
| Organization.identifier.assigner.identifier.use | required | IdentifierUse | ||||
| Organization.identifier.assigner.identifier.type | extensible | Identifier Type Codes | ||||
| Organization.type | required | OrganizationType | ||||
| Organization.contact.purpose | extensible | ContactEntityType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-r4b | warning | Organization.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ide-1 | error | Organization.identifier | The Resource must have at least one Oficial Identifier : | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-4 | error | Organization.identifier | CNPJ validation : |
This structure is derived from Organization
Summary
Mandatory: 4 elements
Structures
This structure refers to these other structures:
- Identifier (https://ancode.app/fhir/StructureDefinition/Identifier)
- ContactPoint (https://ancode.app/fhir/StructureDefinition/ContactPoint)
- Address (https://ancode.app/fhir/StructureDefinition/Address)
Extensions
This structure refers to these extensions:
- https://ancode.app/fhir/StructureDefinition/TerminologyType
- https://ancode.app/fhir/StructureDefinition/TypeHealthcareFacility
- https://ancode.app/fhir/StructureDefinition/ServiceBillingTable
- https://ancode.app/fhir/StructureDefinition/MedicationBillingTable
- https://ancode.app/fhir/StructureDefinition/DeviceBillingTable
- https://ancode.app/fhir/StructureDefinition/BankAccount
- https://ancode.app/fhir/StructureDefinition/BiometricsSettings
- https://ancode.app/fhir/StructureDefinition/Attachment
Differential View
This structure is derived from Organization
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Organization.identifier.type | required | IdentifierTypeOrganization |
| Organization.type | required | OrganizationType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ide-1 | error | Organization.identifier | The Resource must have at least one Oficial Identifier : | |
| org-4 | error | Organization.identifier | CNPJ validation : | |
| org-5 | error | Organization | When type is HealthcareProvider, Location is required : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose org-5: When type is HealthcareProvider, Location is required |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| terminologyType | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/TerminologyType Binding: TerminologyType (required): TerminologyType | |
| typeHealthcareFacility | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/TypeHealthcareFacility Binding: BRTipoEstabelecimentoSaude (required): TypeHealthcareFacility | |
| serviceBillingTable | 0..1 | Reference(Organization) | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ServiceBillingTable | |
| medicationBillingTable | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/MedicationBillingTable | |
| deviceBillingTable | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/DeviceBillingTable | |
| bankAccount | 0..* | (Complex) | Extension URL: https://ancode.app/fhir/StructureDefinition/BankAccount | |
| biometricsSettings | 0..1 | (Complex) | Extension URL: https://ancode.app/fhir/StructureDefinition/BiometricsSettings | |
| Attachment | 0..1 | Attachment | Extension URL: https://ancode.app/fhir/StructureDefinition/Attachment | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | C | 1..* | Identifier | An identifier intended for computation org-4: CNPJ validation |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeOrganization (required) |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
| type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
| name | ΣC | 1..1 | string | Name used for the organization |
| alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| address | C | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Organization.identifier.use | required | IdentifierUse |
| Organization.identifier.type | required | IdentifierTypeOrganization |
| Organization.type | required | OrganizationType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ide-1 | error | Organization.identifier | The Resource must have at least one Oficial Identifier : | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-4 | error | Organization.identifier | CNPJ validation : | |
| org-5 | error | Organization | When type is HealthcareProvider, Location is required : |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose org-5: When type is HealthcareProvider, Location is required | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| terminologyType | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/TerminologyType Binding: TerminologyType (required): TerminologyType | |||||
| typeHealthcareFacility | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/TypeHealthcareFacility Binding: BRTipoEstabelecimentoSaude (required): TypeHealthcareFacility | |||||
| serviceBillingTable | 0..1 | Reference(Organization) | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ServiceBillingTable | |||||
| medicationBillingTable | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/MedicationBillingTable | |||||
| deviceBillingTable | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/DeviceBillingTable | |||||
| bankAccount | 0..* | (Complex) | Extension URL: https://ancode.app/fhir/StructureDefinition/BankAccount | |||||
| biometricsSettings | 0..1 | (Complex) | Extension URL: https://ancode.app/fhir/StructureDefinition/BiometricsSettings | |||||
| Attachment | 0..1 | Attachment | Extension URL: https://ancode.app/fhir/StructureDefinition/Attachment | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | C | 1..* | Identifier | An identifier intended for computation org-4: CNPJ validation | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeOrganization (required) | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 1..1 | string | Text alternative for the resource | ||||
| active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: OrganizationType (required) | ||||
| name | ΣC | 1..1 | string | Name used for the organization | ||||
| alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| address | C | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name | 0..1 | HumanName | A name associated with the contact | |||||
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.identifier.use | required | IdentifierUse | ||||
| Organization.identifier.type | required | IdentifierTypeOrganization | ||||
| Organization.identifier.assigner.type | extensible | ResourceType | ||||
| Organization.identifier.assigner.identifier.use | required | IdentifierUse | ||||
| Organization.identifier.assigner.identifier.type | extensible | Identifier Type Codes | ||||
| Organization.type | required | OrganizationType | ||||
| Organization.contact.purpose | extensible | ContactEntityType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-r4b | warning | Organization.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ide-1 | error | Organization.identifier | The Resource must have at least one Oficial Identifier : | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-4 | error | Organization.identifier | CNPJ validation : |
This structure is derived from Organization
Summary
Mandatory: 4 elements
Structures
This structure refers to these other structures:
- Identifier (https://ancode.app/fhir/StructureDefinition/Identifier)
- ContactPoint (https://ancode.app/fhir/StructureDefinition/ContactPoint)
- Address (https://ancode.app/fhir/StructureDefinition/Address)
Extensions
This structure refers to these extensions:
- https://ancode.app/fhir/StructureDefinition/TerminologyType
- https://ancode.app/fhir/StructureDefinition/TypeHealthcareFacility
- https://ancode.app/fhir/StructureDefinition/ServiceBillingTable
- https://ancode.app/fhir/StructureDefinition/MedicationBillingTable
- https://ancode.app/fhir/StructureDefinition/DeviceBillingTable
- https://ancode.app/fhir/StructureDefinition/BankAccount
- https://ancode.app/fhir/StructureDefinition/BiometricsSettings
- https://ancode.app/fhir/StructureDefinition/Attachment
Other representations of profile: CSV, Excel, Schematron