Guia de Implementação do AnHealth
0.2.0 - CI Build
Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
| Official URL: https://ancode.app/fhir/StructureDefinition/Patient | Version: 0.2.0 | |||
| Draft as of 2021-11-10 | Computable Name: Patient | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
| Path | Conformance | ValueSet |
| Patient.identifier.type | required | IdentifierTypePerson |
| Patient.maritalStatus | required | BrazilianMaritalStatus |
| Patient.photo.contentType | required | MimeType |
| Id | Grade | Path(s) | Details | Requirements |
| ide-1 | error | Patient.identifier | The Resource must have at least one Oficial Identifier : |
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() | 0..1 | string | Extension URL: https://ancode.app/fhir/StructureDefinition/City | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Country Binding: Country (required): Country | |
![]() ![]() | 1..1 | boolean | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ProtectedPerson | |
![]() ![]() | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/Race Binding: Race (required): Race | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Occupation Binding: BRCBO (required): Occupation | |
![]() ![]() | 0..1 | string | Extension URL: https://ancode.app/fhir/StructureDefinition/MotherName | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Ethnicity Binding: BREtnia (required): Ethnicity | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EducationLevel Binding: BRNivelEscolaridade (required): EducationLevel | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/BirthSex Binding: AdministrativeGender (required): BirthSex | |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | C | 0..* | Identifier | An identifier intended for computation |
![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypePerson (required) |
![]() ![]() ![]() ![]() | Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() | Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() | ?!Σ | 1..1 | boolean | Whether this patient's record is in active use |
![]() ![]() | 1..* | HumanName | Name of a human - parts and usage | |
![]() ![]() | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
![]() ![]() | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: BrazilianMaritalStatus (required) | |
![]() ![]() | 0..1 | boolean | Whether patient is part of a multiple birth | |
![]() ![]() | 0..1 | Attachment | Image of the patient | |
![]() ![]() ![]() | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (required) Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.identifier.use | required | IdentifierUse |
| Patient.identifier.type | required | IdentifierTypePerson |
| Patient.gender | required | AdministrativeGender |
| Patient.maritalStatus | required | BrazilianMaritalStatus |
| Patient.photo.contentType | required | MimeType |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | 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 | Patient.identifier | The Resource must have at least one Oficial Identifier : |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() | 0..1 | string | Extension URL: https://ancode.app/fhir/StructureDefinition/City | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Country Binding: Country (required): Country | |||||
![]() ![]() | 1..1 | boolean | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ProtectedPerson | |||||
![]() ![]() | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/Race Binding: Race (required): Race | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Occupation Binding: BRCBO (required): Occupation | |||||
![]() ![]() | 0..1 | string | Extension URL: https://ancode.app/fhir/StructureDefinition/MotherName | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Ethnicity Binding: BREtnia (required): Ethnicity | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EducationLevel Binding: BRNivelEscolaridade (required): EducationLevel | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/BirthSex Binding: AdministrativeGender (required): BirthSex | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | C | 0..* | Identifier | An identifier intended for computation | ||||
![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypePerson (required) | ||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Text alternative for the resource | ||||
![]() ![]() | ?!Σ | 1..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() | 1..* | HumanName | Name of a human - parts and usage | |||||
![]() ![]() | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() | Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
![]() ![]() | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: BrazilianMaritalStatus (required) | |||||
![]() ![]() | 0..1 | boolean | Whether patient is part of a multiple birth | |||||
![]() ![]() | 0..1 | Attachment | Image of the patient | |||||
![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (required) Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): IETF language tag
Example General: en-AU | ||||
![]() ![]() ![]() | 0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() | 0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.identifier.use | required | IdentifierUse | ||||
| Patient.identifier.type | required | IdentifierTypePerson | ||||
| Patient.identifier.assigner.type | extensible | ResourceType | ||||
| Patient.identifier.assigner.identifier.use | required | IdentifierUse | ||||
| Patient.identifier.assigner.identifier.type | extensible | Identifier Type Codes | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | required | BrazilianMaritalStatus | ||||
| Patient.photo.contentType | required | MimeType | ||||
| Patient.photo.language | preferred | CommonLanguages
| ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-r4b | warning | Patient.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 | Patient.identifier | The Resource must have at least one Oficial Identifier : | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Patient
| Path | Conformance | ValueSet |
| Patient.identifier.type | required | IdentifierTypePerson |
| Patient.maritalStatus | required | BrazilianMaritalStatus |
| Patient.photo.contentType | required | MimeType |
| Id | Grade | Path(s) | Details | Requirements |
| ide-1 | error | Patient.identifier | The Resource must have at least one Oficial Identifier : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() | 0..1 | string | Extension URL: https://ancode.app/fhir/StructureDefinition/City | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Country Binding: Country (required): Country | |
![]() ![]() | 1..1 | boolean | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ProtectedPerson | |
![]() ![]() | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/Race Binding: Race (required): Race | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Occupation Binding: BRCBO (required): Occupation | |
![]() ![]() | 0..1 | string | Extension URL: https://ancode.app/fhir/StructureDefinition/MotherName | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Ethnicity Binding: BREtnia (required): Ethnicity | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EducationLevel Binding: BRNivelEscolaridade (required): EducationLevel | |
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/BirthSex Binding: AdministrativeGender (required): BirthSex | |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | C | 0..* | Identifier | An identifier intended for computation |
![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypePerson (required) |
![]() ![]() ![]() ![]() | Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() | Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() | ?!Σ | 1..1 | boolean | Whether this patient's record is in active use |
![]() ![]() | 1..* | HumanName | Name of a human - parts and usage | |
![]() ![]() | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
![]() ![]() | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: BrazilianMaritalStatus (required) | |
![]() ![]() | 0..1 | boolean | Whether patient is part of a multiple birth | |
![]() ![]() | 0..1 | Attachment | Image of the patient | |
![]() ![]() ![]() | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (required) Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.identifier.use | required | IdentifierUse |
| Patient.identifier.type | required | IdentifierTypePerson |
| Patient.gender | required | AdministrativeGender |
| Patient.maritalStatus | required | BrazilianMaritalStatus |
| Patient.photo.contentType | required | MimeType |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | 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 | Patient.identifier | The Resource must have at least one Oficial Identifier : |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() | 0..1 | string | Extension URL: https://ancode.app/fhir/StructureDefinition/City | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Country Binding: Country (required): Country | |||||
![]() ![]() | 1..1 | boolean | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ProtectedPerson | |||||
![]() ![]() | 0..1 | CodeableConcept | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/Race Binding: Race (required): Race | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Occupation Binding: BRCBO (required): Occupation | |||||
![]() ![]() | 0..1 | string | Extension URL: https://ancode.app/fhir/StructureDefinition/MotherName | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/Ethnicity Binding: BREtnia (required): Ethnicity | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EducationLevel Binding: BRNivelEscolaridade (required): EducationLevel | |||||
![]() ![]() | 0..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/BirthSex Binding: AdministrativeGender (required): BirthSex | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | C | 0..* | Identifier | An identifier intended for computation | ||||
![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypePerson (required) | ||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Text alternative for the resource | ||||
![]() ![]() | ?!Σ | 1..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() | 1..* | HumanName | Name of a human - parts and usage | |||||
![]() ![]() | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() | Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
![]() ![]() | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: BrazilianMaritalStatus (required) | |||||
![]() ![]() | 0..1 | boolean | Whether patient is part of a multiple birth | |||||
![]() ![]() | 0..1 | Attachment | Image of the patient | |||||
![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeType (required) Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): IETF language tag
Example General: en-AU | ||||
![]() ![]() ![]() | 0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() | 0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.identifier.use | required | IdentifierUse | ||||
| Patient.identifier.type | required | IdentifierTypePerson | ||||
| Patient.identifier.assigner.type | extensible | ResourceType | ||||
| Patient.identifier.assigner.identifier.use | required | IdentifierUse | ||||
| Patient.identifier.assigner.identifier.type | extensible | Identifier Type Codes | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | required | BrazilianMaritalStatus | ||||
| Patient.photo.contentType | required | MimeType | ||||
| Patient.photo.language | preferred | CommonLanguages
| ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-r4b | warning | Patient.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 | Patient.identifier | The Resource must have at least one Oficial Identifier : | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron