Environments
The Maternity record API exists in several environments, mainly three of which are currently being used for external API consumers; Test, QA and Prod.
Test and QA are available on both the internet and the health network (Helsenettet), while Prod is only available on the health network and data center network. It is therefore a requirement that your organization is a member of health network in order to consume the API.
Below is an overview of the available environments, as well as which DNS they are available on. Be sure to use the correct URL for the type availability you want (internet, health network or internal/Data Center Network)
| Environment | Base-Url | Availability (DNS) | Description |
|---|---|---|---|
| Test | https://test.maternity-record.hit.nhn.no | Internet | Test environment for external consumers |
| Test | https://test.hn.maternity-record.hit.nhn.no | Health Network | Test environment for external consumers |
| QA | https://qa.hn.maternity-record.hit.nhn.no | Health Network | Production-like environment |
| QA | https://qa.dc.maternity-record.hit.nhn.no | Data Center Network | Production-like environment |
| Prod | https://hn.maternity-record.hit.nhn.no | Helsenett | Production environment |
| Prod | https://dc.maternity-record.hit.nhn.no | Data Center Network | Production environment |
Path
The base url for the API is /api/maternity-record, eg: https://test.maternity-record.hit.nhn.no/api/maternity-record/ping
For the actual health data API, we use versioning, so for endpoints other than ping, version must be specified. Eg: https://test.maternity-record.hit.nhn.no/api/maternity-record/v1/dhg So the path for most requests wil be:
BASE-URL/api/maternity-record/v1/xxx
Test
- The main test environment, testing across environments in NHN and for external consumers.
- Used for functional testing of integration from subject system to the service.
- Variable stability should be expected.
- We do not want the environment to be used for performance testing without prior agreement.
- Link to ping endpoint (internet)
QA
- Prod-like environment used for testing across environments in NHN and for external ones.
- Used to test the integration in a prod-like context.
Prod
- Production environment.
- Production must never, under any circumstances, be used for testing either on test persons or real persons.
Please note that all new services made available from NHN's Private Cloud are published on a different IP segment than certain others NHN services. If your organization already consumes services via the health network, you may have to add new firewall rules for NHN's Private Cloud.