3.0.0-alpha - ci-build
3.0.0-alpha - ci-build
Publication Build: This will be filled in by the publication tooling
| Official URL: http://hl7.no/fhir/StructureDefinition/no-basis-Patient | Version: 3.0.0-alpha | |||
| Active as of 2019-05-20 | Computable Name: NoBasisPatient | |||
Basisprofil for Norwegian Patient information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. Should be used as a basis for further profiling in use-cases where specific identity information is needed. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  citizenship | 0..* | (Complex) | The citizenship of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |
  extension:code | 0..1 | Extension | Extension | |
   value[x] | 1..1 | CodeableConcept | Value of extension Binding: urn:iso:std:iso:3166 (example) | |
 Slices for identifier | 0..* | Identifier | Identifier for this patient Slice: Unordered, Open by value:system | |
 identifier:FNR | 0..* | Identifier | Norwegian FNR | |
  system | 1..1 | uri | Identification of the Norwegian FNR Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1 | |
| value | 1..1 | string | The actual Fødselsnummer Example Fødselsnummer: 13057444850 | |
| identifier:FHN | 0..* | Identifier | Felles hjelpenummer used for the patient | |
| system | 1..1 | uri | Identification of the Norwegian felles hjelpenummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3 | |
| value | 1..1 | string | The actual Hjelpenummer | |
| identifier:DNR | 0..* | Identifier | The D-nummer of the patient | |
| system | 1..1 | uri | The identification of the D-nummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2 | |
| value | 1..1 | string | The actual D-nummer | |
 identifier:HNR | 0..* | Identifier | A locally assigned H-nummer | |
 type | ||||
  coding | ||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.578.1.12.4.1.1.8327 | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HNR | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: HNR | |
| value | 1..1 | string | The value that is unique | |
| assigner | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
 name | 0..* | NoBasisHumanName | Norwegian human name | |
| address | 0..* | NoBasisAddress | Norwegian address | |
| contact | ||||
| name | 0..1 | NoBasisHumanName | Norwegian human name | |
| address | 0..1 | NoBasisAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:citizenship.extension:code.value[x] | example | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| citizenship | 0..* | (Complex) | The citizenship of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |
| extension:code | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "code" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: urn:iso:std:iso:3166 (example) | |
| extension:period | 0..1 | Extension | Time period of citizenship | |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| value[x] | 1..1 | Period | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 0..* | Identifier | Identifier for this patient Slice: Unordered, Open by value:system |
| identifier:FNR | Σ | 0..* | Identifier | Norwegian FNR |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | Identification of the Norwegian FNR Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1 |
| value | ΣC | 1..1 | string | The actual Fødselsnummer Example General: 123456 Example Fødselsnummer: 13057444850 |
| identifier:FHN | Σ | 0..* | Identifier | Felles hjelpenummer used for the patient |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | Identification of the Norwegian felles hjelpenummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3 |
| value | ΣC | 1..1 | string | The actual Hjelpenummer Example General: 123456 |
| identifier:DNR | Σ | 0..* | Identifier | The D-nummer of the patient |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The identification of the D-nummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2 |
| value | ΣC | 1..1 | string | The actual D-nummer Example General: 123456 |
| identifier:HNR | Σ | 0..* | Identifier | A locally assigned H-nummer |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: HNR |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
 assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | 0..* | NoBasisHumanName | Norwegian human name | |
 deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | 0..* | NoBasisAddress | Norwegian address | |
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:citizenship.extension:code.value[x] | example | |
| Patient.identifier:FNR.use | required | IdentifierUse |
| Patient.identifier:FHN.use | required | IdentifierUse |
| Patient.identifier:DNR.use | required | IdentifierUse |
| Patient.identifier:HNR.use | required | IdentifierUse |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| 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: AllLanguages (required): IETF language tag for a human language | |
| 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 | |
| citizenship | 0..* | (Complex) | The citizenship of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:code | 0..1 | Extension | Extension | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "code" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: urn:iso:std:iso:3166 (example) | |
| extension:period | 0..1 | Extension | Time period of citizenship | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| value[x] | 1..1 | Period | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 0..* | Identifier | Identifier for this patient Slice: Unordered, Open by value:system |
| identifier:FNR | Σ | 0..* | Identifier | Norwegian FNR |
| 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): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | Identification of the Norwegian FNR Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1 |
| value | ΣC | 1..1 | string | The actual Fødselsnummer Example General: 123456 Example Fødselsnummer: 13057444850 |
| 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) |
| identifier:FHN | Σ | 0..* | Identifier | Felles hjelpenummer used for the patient |
| 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): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | Identification of the Norwegian felles hjelpenummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3 |
| value | ΣC | 1..1 | string | The actual Hjelpenummer 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) |
| identifier:DNR | Σ | 0..* | Identifier | The D-nummer of the patient |
| 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): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | The identification of the D-nummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2 |
| value | ΣC | 1..1 | string | The actual D-nummer 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) |
| identifier:HNR | Σ | 0..* | Identifier | A locally assigned H-nummer |
| 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): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| 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 | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.578.1.12.4.1.1.8327 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HNR |
| display | ΣC | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: HNR |
| value | ΣC | 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 | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | 0..* | NoBasisHumanName | Norwegian human name | |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date of birth for the individual |
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | 0..* | NoBasisAddress | Norwegian address | |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| photo | 0..* | Attachment | Image of the patient | |
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| 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 |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| name | 0..1 | NoBasisHumanName | Norwegian human name | |
| telecom | C | 0..* | ContactPoint | A contact detail for the person |
| address | 0..1 | NoBasisAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact |
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
| 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 |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language | |
| preferred | 0..1 | boolean | Language preference indicator | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
| 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 |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.language | required | AllLanguages |
| Patient.extension:citizenship.extension:code.value[x] | example | |
| Patient.identifier:FNR.use | required | IdentifierUse |
| Patient.identifier:FNR.type | extensible | IdentifierTypeCodes |
| Patient.identifier:FHN.use | required | IdentifierUse |
| Patient.identifier:FHN.type | extensible | IdentifierTypeCodes |
| Patient.identifier:DNR.use | required | IdentifierUse |
| Patient.identifier:DNR.type | extensible | IdentifierTypeCodes |
| Patient.identifier:HNR.use | required | IdentifierUse |
| Patient.identifier:HNR.type | extensible | IdentifierTypeCodes |
| Patient.gender | required | AdministrativeGender |
| Patient.maritalStatus | extensible | MaritalStatusCodes |
| Patient.contact.relationship | extensible | PatientContactRelationship |
| Patient.contact.gender | required | AdministrativeGender |
| Patient.communication.language | required | AllLanguages |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| 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: 0 element (11 nested mandatory elements)
Fixed Value: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| citizenship | 0..* | (Complex) | The citizenship of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |
| extension:code | 0..1 | Extension | Extension | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: urn:iso:std:iso:3166 (example) | |
| Slices for identifier | 0..* | Identifier | Identifier for this patient Slice: Unordered, Open by value:system | |
| identifier:FNR | 0..* | Identifier | Norwegian FNR | |
| system | 1..1 | uri | Identification of the Norwegian FNR Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1 | |
| value | 1..1 | string | The actual Fødselsnummer Example Fødselsnummer: 13057444850 | |
| identifier:FHN | 0..* | Identifier | Felles hjelpenummer used for the patient | |
| system | 1..1 | uri | Identification of the Norwegian felles hjelpenummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3 | |
| value | 1..1 | string | The actual Hjelpenummer | |
| identifier:DNR | 0..* | Identifier | The D-nummer of the patient | |
| system | 1..1 | uri | The identification of the D-nummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2 | |
| value | 1..1 | string | The actual D-nummer | |
| identifier:HNR | 0..* | Identifier | A locally assigned H-nummer | |
| type | ||||
| coding | ||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.578.1.12.4.1.1.8327 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HNR | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: HNR | |
| value | 1..1 | string | The value that is unique | |
| assigner | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| name | 0..* | NoBasisHumanName | Norwegian human name | |
| address | 0..* | NoBasisAddress | Norwegian address | |
| contact | ||||
| name | 0..1 | NoBasisHumanName | Norwegian human name | |
| address | 0..1 | NoBasisAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:citizenship.extension:code.value[x] | example | |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| citizenship | 0..* | (Complex) | The citizenship of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |
| extension:code | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "code" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: urn:iso:std:iso:3166 (example) | |
| extension:period | 0..1 | Extension | Time period of citizenship | |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| value[x] | 1..1 | Period | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 0..* | Identifier | Identifier for this patient Slice: Unordered, Open by value:system |
| identifier:FNR | Σ | 0..* | Identifier | Norwegian FNR |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | Identification of the Norwegian FNR Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1 |
| value | ΣC | 1..1 | string | The actual Fødselsnummer Example General: 123456 Example Fødselsnummer: 13057444850 |
| identifier:FHN | Σ | 0..* | Identifier | Felles hjelpenummer used for the patient |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | Identification of the Norwegian felles hjelpenummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3 |
| value | ΣC | 1..1 | string | The actual Hjelpenummer Example General: 123456 |
| identifier:DNR | Σ | 0..* | Identifier | The D-nummer of the patient |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The identification of the D-nummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2 |
| value | ΣC | 1..1 | string | The actual D-nummer Example General: 123456 |
| identifier:HNR | Σ | 0..* | Identifier | A locally assigned H-nummer |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: HNR |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | 0..* | NoBasisHumanName | Norwegian human name | |
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | 0..* | NoBasisAddress | Norwegian address | |
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:citizenship.extension:code.value[x] | example | |
| Patient.identifier:FNR.use | required | IdentifierUse |
| Patient.identifier:FHN.use | required | IdentifierUse |
| Patient.identifier:DNR.use | required | IdentifierUse |
| Patient.identifier:HNR.use | required | IdentifierUse |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| 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: AllLanguages (required): IETF language tag for a human language | |
| 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 | |
| citizenship | 0..* | (Complex) | The citizenship of the patient URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:code | 0..1 | Extension | Extension | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "code" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: urn:iso:std:iso:3166 (example) | |
| extension:period | 0..1 | Extension | Time period of citizenship | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| value[x] | 1..1 | Period | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 0..* | Identifier | Identifier for this patient Slice: Unordered, Open by value:system |
| identifier:FNR | Σ | 0..* | Identifier | Norwegian FNR |
| 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): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | Identification of the Norwegian FNR Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1 |
| value | ΣC | 1..1 | string | The actual Fødselsnummer Example General: 123456 Example Fødselsnummer: 13057444850 |
| 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) |
| identifier:FHN | Σ | 0..* | Identifier | Felles hjelpenummer used for the patient |
| 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): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | Identification of the Norwegian felles hjelpenummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3 |
| value | ΣC | 1..1 | string | The actual Hjelpenummer 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) |
| identifier:DNR | Σ | 0..* | Identifier | The D-nummer of the patient |
| 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): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | The identification of the D-nummer Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2 |
| value | ΣC | 1..1 | string | The actual D-nummer 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) |
| identifier:HNR | Σ | 0..* | Identifier | A locally assigned H-nummer |
| 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): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| 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 | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.578.1.12.4.1.1.8327 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HNR |
| display | ΣC | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: HNR |
| value | ΣC | 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 | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | 0..* | NoBasisHumanName | Norwegian human name | |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date of birth for the individual |
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | 0..* | NoBasisAddress | Norwegian address | |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| photo | 0..* | Attachment | Image of the patient | |
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| 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 |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| name | 0..1 | NoBasisHumanName | Norwegian human name | |
| telecom | C | 0..* | ContactPoint | A contact detail for the person |
| address | 0..1 | NoBasisAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact |
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
| 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 |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language | |
| preferred | 0..1 | boolean | Language preference indicator | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
| link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
| 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 |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.language | required | AllLanguages |
| Patient.extension:citizenship.extension:code.value[x] | example | |
| Patient.identifier:FNR.use | required | IdentifierUse |
| Patient.identifier:FNR.type | extensible | IdentifierTypeCodes |
| Patient.identifier:FHN.use | required | IdentifierUse |
| Patient.identifier:FHN.type | extensible | IdentifierTypeCodes |
| Patient.identifier:DNR.use | required | IdentifierUse |
| Patient.identifier:DNR.type | extensible | IdentifierTypeCodes |
| Patient.identifier:HNR.use | required | IdentifierUse |
| Patient.identifier:HNR.type | extensible | IdentifierTypeCodes |
| Patient.gender | required | AdministrativeGender |
| Patient.maritalStatus | extensible | MaritalStatusCodes |
| Patient.contact.relationship | extensible | PatientContactRelationship |
| Patient.contact.gender | required | AdministrativeGender |
| Patient.communication.language | required | AllLanguages |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| 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: 0 element (11 nested mandatory elements)
Fixed Value: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron